История страницы

properties

name

return value

description

methods

name

return value

description

properties

     * Перечисление возможных типов бороды.
     * @author Gleb Nozdrachev
     * 
     * @see SOBeard.DocflowData#getType()
     */
    enum Type implements Serializable {

        /**
         * Сотрудник системной организации
         */
        SYS_HUMAN,

        /**
         * Структурное подразделение системной организации
         */
        SYS_DEPARTMENT,

        /**
         * Cистемная организация
         */
        SYS_ORGANIZATION,

        /**
         * Cистемная роль
         */
        SYS_ROLE,

        /**
         * Сотрудник несистемной организации
         */
        NONSYS_HUMAN,

        /**
         * Несистемная организация
         */
        NONSYS_ORGANIZATION,

        /**
         * Частное лицо
         */
        PRIVATE_HUMAN,

        /**
         * Контекстная роль
         */
        CONTEXT_ROLE,

        /**
         * Субъект СО, отсутствующий в справочнике в "явном" виде. Объекты такого типа создаются автоматически -
         * при обработке прикладных документов.
         */
        ABSENT,

        /**
         * Реляция
         */
        SYS_RELATION

    }

    /**
     * Возвращает название организации бороды.
     * @return не может быть <code>null</code>
     */
    String getOrganizationName ();

    /**
     * Возвращает доменный объект-Организацию для данной бороды.
     * Для "Системной организации", т.е. если <code>{@link SOBeard.Type} == {@link SOBeard.Type#SYS_ORGANIZATION}</code>,
     * необходима конкретезация СпО.
     * Для foreign-бород возможны ситуации, когда не удается однозначно определить СпО, из которой должно быть получено описание организации
     * (например, в процедуре, работающей по расписанию под правами сервера). В таком случае будет получено первое попавшееся описание организации.
     * Описания организаций для foreign-бород идентичны с точностью до значения колонки active.
     * @param spoComplect - комплект СпО в котором необходимо искать связанную СО.
     * @param replicaSO - СО в которой необходимо искать СпО.
     * @return null для "частного лица", т.е. если <code>{@link SOBeard.Type} == {@link SOBeard.Type#PRIVATE_HUMAN}</code>
     *
     * @see SOOrganizationDescription
     */
    SOOrganizationDescription getOrganization (String spoComplect, String replicaSO);

    /**
     * Возвращает доменный объект-Организацию для данной бороды.
     * Для "Системной организации", т.е. если <code>{@link SOBeard.Type} == {@link SOBeard.Type#SYS_ORGANIZATION}</code>,
     * необходима конкретезация СпО.
     * Для foreign-бород возможны ситуации, когда не удается однозначно определить СпО, из которой должно быть получено описание организации
     * (например, в процедуре, работающей по расписанию под правами сервера). В таком случае будет получено первое попавшееся описание организации.
     * Описания организаций для foreign-бород идентичны с точностью до значения колонки active.
     * @param spoComplect - комплект СпО в котором необходимо искать связанную СО.
     * @return null для "частного лица", т.е. если <code>{@link SOBeard.Type} == {@link SOBeard.Type#PRIVATE_HUMAN}</code>
     *
     * @see SOOrganizationDescription
     */
    SOOrganizationDescription getOrganization (String spoComplect);

    /**
     * Перечисление возможных форматов бороды для метода <code>{@link SOBeard#toString(ToStringFormat)}</code>.
     * @author Gleb Nozdrachev
     */
    enum ToStringFormat {

        /**
         * Стандартный формат отображения: ФИО, ДОЛЖНОСТЬ (ПОДРАЗДЕЛЕНИЕ). Этот формат используется при
         * вызове метода <code>{@link Object#toString()}</code> без параметров.
         */
        DEFAULT,

        /**
         * Стандартный формат для CM-Domino (5 компонент для "системного", 4 для "несистемного") через "%".
         */
        CMDOMINO_STD,

        /**
         * Разновидность формата для CM-Domino (6 компонент - дополнительно с названием организации - для "системного", 4 для "несистемного") через "%".
         */
        CMDOMINO_WITH_ORG_IF_SYSTEM,
        /**
         * если выбиралась только организация - "название огранизации" % docid % replica-SpO
         * если выбирался сотрудник из организации - ФИО % docid % replica-Spp
         * если выбиралось частное лицо - ФИО % docid % replica-Spp
         */
        CMDOMINO_SHORT_SENDING,

        /**
         * Краткое имя
         */
        CMDOMINO_SHORT_NAME,

        /**
         * только реплика и UNID
         */
        CMDOMINO_ID

    }

    /**
     * Возвращает строковое представление бороды в указанном формате.
     * 
     * @param format - заданный формат; не может быть <code>null</code>
     * @return не может быть <code>null</code>
     * 
     * @see SOBeard.ToStringFormat
     */
    String toString (ToStringFormat format);

    
 methods

    /**
     * Интерфейс-композит "данные об оригинальной / эффективной части бороды".
     * @author Gleb Nozdrachev
     * 
     * @see SOBeard#originalData()
     * @see SOBeard#effectiveData()
     */
    interface DocflowData {

        /**
         * Возвращает тип бороды.
         * @return не может быть <code>null</code>
         * 
         * @see SOBeard.Type
         */
        Type getType ();

interface <DocflowData>

property

    }

    /**
     * Возвращает внешний идентификатор бороды.
     * 
     * @return может быть {@code null}.
     */
    String getIntegrationId();
    
    /**
     * Возвращает адрес бороды (только для некоторых типов бород).
     * @return не может быть <code>null</code>
     */
    String getAddress ();
    
    /**
     * Возвращает признак того, что борода создана из "чужой" системной организации.
     */
    boolean isForeign ();

    /**
     * Возвращает сеть бороды.
     * 
     * @return может быть {@code null}.
     */
    default String getNativeNet() {
        return null;
    }
    
    /**
     * Возвращает домашнюю сеть бороды.
     * 
     * @return может быть {@code null}.
     */
    default String getHomeNet() {
        return null;
    } 

     /**
     * Признак, что сотрудник подключен к системе.
     * 
     * @return {@code true} - если подключен и может работать в системе в
     *         "полном" режиме, {@code false} - не подключен и не имеет
     *         возможности работать полноценно в системе.
     */
    boolean isConnectedToSystem();
    
    boolean hasPhoto();
    
    void setPhotoAvailable(boolean hasPhoto);

    /**
     * Возвращает название файла фото.
     * @return может быть {@code null}.
     */
    @Nullable
    String getPhotoFileName();

    /**
     * Устанавливает название файла фото.
     * @param photoFileName - может быть {@code null}.
     */
    void setPhotoFileName(String photoFileName);

    Set<SOBeard> getJoined();

    /**
     * Обособленное подразделение бороды
     * @return - обособленное подразделение бороды, можеть быть {@code null}
     * @see SOBeard
     */
    @Nullable
    SOBeard.Mapped getIsolatedDep();

    /**
     * @param location - обособленное подразделение бороды, можеть быть {@code null}
     */
    void setIsolatedDep(@Nullable SOBeard.Mapped location);

 enum <Type>

enum <ToStringFormat>