AFUserProfile

properties

methods

class <>

properties

    
    /**
     * Возвращает список групп доступа ШЕ/СЕ, замещаемых данным пользователем.
     * 
     * @see #isSubstituteOfAny(Set)
     * @return не может быть {@code null}.
     */
    @Nonnull
    Set<String> getGDsSubstituteOf();
    
    /**
     * Возвращает признак замещает ли данный пользователь какого-либо (хотя бы одного) 
     * пользователя на основании сравнения доступа по переданному множеству групп доступа пользователей.
     * 
     * @see #getSubstituteOfGDs()
     * 
     * @param gds - группы доступа для сравнения, не может быть {@code false}.
     * @return {@code true} - если замещает, {@code false} - иначе.
     */
    boolean isSubstituteOfAny(Set<String> gds);

    /**
     * Возвращает признак "замещает ли данный пользователь другого пользователя,
     * указанного в параметре метода".
     *
     * @param beardId
     *            - идентификатор бороды проверяемого пользователя; не может быть
     *            <code>null</code>
     *            
     * @return <code>true</code> - если замещает; <code>false</code> в противном
     *         случае
     *         
     * @see #getIDSubstitutedFrom(Iterable)
     * @see SOBeard
     */
    boolean isSubstituteOf(String beardId);

    /**
     * Возвращает признак "замещает ли данный пользователь другого пользователя,
     * указанного в параметре метода, "по подписи"".
     *
     * @param beard
     *            - борода проверяемого пользователя; не может быть
     *            <code>null</code>
     *            
     * @return <code>true</code> - если замещает; <code>false</code> в противном
     *         случае
     *         
     * @see #getIDSubstitutedFrom(Iterable)
     * @see SOBeard
     */
    boolean isSigningSubstituteOf(SOBeard beard);

    /**
     * Возвращает признак "замещает ли данный пользователь другого пользователя,
     * указанного в параметре метода, "по согласованию"".
     *
     * @param beard
     *            - борода проверяемого пользователя; не может быть
     *            <code>null</code>
     *            
     * @return <code>true</code> - если замещает; <code>false</code> в противном
     *         случае
     *         
     * @see #getIDSubstitutedFrom(Iterable)
     * @see SOBeard
     */
    boolean isApprovingSubstituteOf(SOBeard beard);

    /**
     * Возвращает список ID-ов бород, замещаемых данным пользователем из списка
     * указанных в параметре метода. Если сам пользователь входит в список
     * проверяемых, то ID его бороды будет находиться на <b>первой</b> позиции в
     * возвращенном списке.
     *
     * @param beards
     *            - список бород проверяемых пользователей; не может быть
     *            <code>null</code>
     * @return не может быть <code>null</code>
     * 
     * @see #getSubstitutedFrom(Iterable)
     * @see #isSubstituteOf(SOBeard)
     * @see SOBeard
     */
    List<String> getIDSubstitutedFrom(Iterable<SOBeard> beards);

    /**
     * Возвращает список ID-ов бород, замещаемых данным пользователем из списка
     * указанных в параметре метода. Если сам пользователь входит в список
     * проверяемых, то ID его бороды будет находиться на <b>первой</b> позиции в
     * возвращенном списке.
     *
     * @param beardIds
     *            - список идентификаторов бород проверяемых пользователей; не
     *            может быть <code>null</code>
     * @return не может быть <code>null</code>
     * 
     * @see #getIDSubstitutedFrom(Iterable)
     * @see #isSubstituteOf(SOBeard)
     * @see SOBeard
     */
    List<String> getIDSubstitutedFromIDs(Iterable<String> beardIds);

    /**
     * Возвращает список ID-ов бород, замещаемых данным пользователем из списка
     * указанных в параметре метода "по подписи". Если сам пользователь входит в список
     * проверяемых, то ID его бороды будет находиться на <b>первой</b> позиции в
     * возвращенном списке.
     *
     * @param beards
     *            - список бород проверяемых пользователей; не может быть
     *            <code>null</code>
     * @return не может быть <code>null</code>
     * 
     * @see #getSubstitutedFrom(Iterable)
     * @see #isSubstituteOf(SOBeard)
     * @see SOBeard
     */
    List<String> getIDSigningSubstitutedFrom(Iterable<SOBeard> beards);

    /**
     * Возвращает список ID-ов бород, замещаемых данным пользователем из списка
     * указанных в параметре метода "по согласованию". Если сам пользователь входит в список
     * проверяемых, то ID его бороды будет находиться на <b>первой</b> позиции в
     * возвращенном списке.
     *
     * @param beards
     *            - список бород проверяемых пользователей; не может быть
     *            <code>null</code>
     * @return не может быть <code>null</code>
     * 
     * @see #getSubstitutedFrom(Iterable)
     * @see #isSubstituteOf(SOBeard)
     * @see SOBeard
     */
    List<String> getIDApprovingSubstitutedFrom(Iterable<SOBeard> beards);

    /**
     * Возвращает список бород, замещаемых данным пользователем из списка
     * указанных в параметре метода. Если сам пользователь входит в список
     * проверяемых, то его борода будет находиться на <b>первой</b> позиции в
     * возвращенном списке.
     * <p>
     * В случае, если от бород из полученного списка требуется только
     * идентификатор, рекомендуется использовать более "быстрый" метод
     * {@link #getIDSubstitutedFrom(Iterable)}.
     *
     * @param beards
     *            - список бород проверяемых пользователей; не может быть
     *            <code>null</code>
     * @return не может быть <code>null</code>
     * 
     * @see #getIDSubstitutedFrom(Iterable)
     * @see #isSubstituteOf(SOBeard)
     * @see SOBeard
     */
    List<SOBeard> getSubstitutedFrom(Iterable<SOBeard> beards);

    /**
     * Возвращает список бород, замещаемых данным пользователем из списка
     * указанных в параметре метода "по подписи". Если сам пользователь входит в список
     * проверяемых, то его борода будет находиться на <b>первой</b> позиции в
     * возвращенном списке.
     * <p>
     * В случае, если от бород из полученного списка требуется только
     * идентификатор, рекомендуется использовать более "быстрый" метод
     * {@link #getIDSubstitutedFrom(Iterable)}.
     *
     * @param beards
     *            - список бород проверяемых пользователей; не может быть
     *            <code>null</code>
     * @return не может быть <code>null</code>
     * 
     * @see #getIDSubstitutedFrom(Iterable)
     * @see #isSubstituteOf(SOBeard)
     * @see SOBeard
     */
    List<SOBeard> getSigningSubstitutedFrom(Iterable<SOBeard> beards);

    /**
     * Возвращает список бород, замещаемых данным пользователем из списка
     * указанных в параметре метода "по согласованию". Если сам пользователь входит в список
     * проверяемых, то его борода будет находиться на <b>первой</b> позиции в
     * возвращенном списке.
     * <p>
     * В случае, если от бород из полученного списка требуется только
     * идентификатор, рекомендуется использовать более "быстрый" метод
     * {@link #getIDSubstitutedFrom(Iterable)}.
     *
     * @param beards
     *            - список бород проверяемых пользователей; не может быть
     *            <code>null</code>
     * @return не может быть <code>null</code>
     * 
     * @see #getIDSubstitutedFrom(Iterable)
     * @see #isSubstituteOf(SOBeard)
     * @see SOBeard
     */
    List<SOBeard> getApprovingSubstitutedFrom(Iterable<SOBeard> beards);

    /**
     * Возвращает список бород замещающих данного пользователя: <b>всех
     * должностей</b> пользователя, <b>с учетом передачи дел</b>.
     *
     * @return не может быть <code>null</code>
     * 
     * @see SOBeard
     */
    Set<SOBeard> getSubstitutes();

    /**
     * Возвращает список бород замещающих данного пользователя "по подписи": <b>всех
     * должностей</b> пользователя, <b>с учетом передачи дел</b>.
     *
     * @return не может быть <code>null</code>
     * 
     * @see SOBeard
     */
    Set<SOBeard> getSigningSubstitutes();

    /**
     * Возвращает список бород замещающих данного пользователя "по согласованию": <b>всех
     * должностей</b> пользователя, <b>с учетом передачи дел</b>.
     *
     * @return не может быть <code>null</code>
     * 
     * @see SOBeard
     */
    Set<SOBeard> getApprovingSubstitutes();

    /**
     * Возвращает время, когда данный пользователь последний раз производил
     * какие-либо "модифицирующие" действия в Системе, т.е. создавал,
     * редактировал или удалял документы.
     *
     * @return может быть <code>null</code>
     * 
     * @see #logModifyingAction()
     */
    Date getLastModifyingActionTime();

    /**
     * Фиксирует в Системе "модифицирующее" действие пользователя, т.е. действие
     * по созданию, редактированию или удалению документа.
     *
     * @see #getLastModifyingActionTime()
     */
    void logModifyingAction();

    /**
     * Расширенные аттрибуты профиля пользователя. Предназначены для хранения
     * различной прикладной информации.
     * 
     * @return аттрибуты профиля
     */
    Map<String, Object> extendedAttributes();

    /**
     * Метод устанавливает unid бороды замещаемого сотрудника, профиль которого
     * выбран в качестве рабочего.
     * @param workProfileSOBeardUnid рабочий профиль сотрудника
     */
    void setWorkProfileSOBeardUnid(String workProfileSOBeardUnid);

    /**
     * Метод возвращает unid бороды замещаемого сотрудника, профиль которого
     * выбран в качестве рабочего.
     * 
     * @return unid замещаемого сотрудника
     */
    String getWorkProfileSOBeardUnid();

    /**
     * Метод возвращает Основной профиль замещаемого сотрудника, который выбран в
     * качестве рабочего.
     * 
     * @return основной профиль замещаемого сотрудника
     */
    AFWorkProfile getWorkProfile();

    /**
     * Возвращает список бород с основными назначениями, замещаемых данным
     * пользователем: <b>всеми должностями</b> пользователя, <b>без учета
     * передачи дел</b>.
     *
     * @return список бород
     * @see #getIDSubstituteOf()
     * @see #isSubstituteOf(SOBeard)
     * @see SOBeard
     */
    Set<SOBeard> getSpecSubstituteOf();

    /**
     * Возвращает рабочий профиль пользователя в случае, если не null, иначе
     * возвращает текущий.
     * 
     * @return рабочий или текущий профиль
     */
    AFWorkProfile getWorkProfileOrCurrent();

    /**
     * Сбрасывает внутренний кеш.
     */
    void dropCache ();

    /**
     * Возвращает список ролей данного пользователя.
     *
     * @return не может быть <code>null</code>
     */
    Set<String> getRoles();

    /**
     * Возвращает список праздничных дней
     *
     * @return может быть <code>null</code>
     */
    List<Holiday> getHolidays();

    /**
     * Возвращает список - время начала и время окончания рабочего дня
     *
     * @param type     параметр
     * @param cyclePos параметр
     * @return не может быть <code>null</code>
     */
    List<Date> getWorkTime(int type, int cyclePos);

    //-------------------------------------------
    /**
     * Возвращает список - время начала и время окончания рабочего дня
     * для дефолтного профиля
     *
     * @param type параметр
     * @param cyclePos параметр
     * @return не может быть <code>null</code>
     */
    List<Date> getWorkTimeFromDefaultWTP(int type,int cyclePos);
    /**
     * Возвращает список праздничных дней
     * для дефолтного профиля
     *
     * @return может быть <code>null</code>
     */
    List<Holiday> getHoliDaysFromDefaultWTP();
    boolean isThereAWorkDefaultProfile();

    /**
     * Возвращает рабочий цикл.
     * для дефолтного профиля
     *
     * @return не может быть <code>null</code>
     */
    List<String> getWorkCycleFromDefaultWTP();
    
    /**
     * Возвращает дату начала рабочего цикла.
     * для дефолтного профиля
     *
     * @return не может быть <code>null</code>
     */
    Date getStartWorkTimeFromDefaultWTP();
    
    //-------------------------------------------
    /**
     * Возвращает дату начала рабочего цикла.
     *
     * @return не может быть <code>null</code>
     */
    Date getStartWorkTime();
    
    /**
     * Возвращает рабочий цикл.
     * 
     * @return не может быть <code>null</code>
     */
    List<String> getWorkCycle();
    
    /**
     * Возвращает настройки профиля рабочего времени пользователя.
     *
     * @return не может быть <code>null</code>
     */
    WorkTimeSettings getWorkTimeSettings();
    
    /**
     * Возвращает настройки профиля рабочего времени "по-умолчанию".
     *
     * @return не может быть <code>null</code>
     */
    WorkTimeSettings getDefaultWorkTimeSettings();

    /**
     * Возвращает конфиг стопок для пользователя
     *
     * @return Set of configured task stacks
     */
    @Nonnull
    Set<StackConfig> getStackConfigs();

    /**
     * Исключение из рабочего цикла
     * @author Alimurad Ramazanov
     *
     */
    interface WorkTimeExclusion {

        /**
         * Дата исключения из рабочего цикла
         * @return дата
         */
        Date getDate();

        /**
         * Каждый год или только указанный
         * @return true, если праздничный день каждый год
         */
        boolean isEveryYear();
    }
    
    /**
     * Праздничный день из рабочего профиля
     */
    interface Holiday extends WorkTimeExclusion {

    }

    interface WorkingDay extends WorkTimeExclusion {

        /**
         * Возвращает время обеда, начала и окончания дня, а также расчетный час дня исключения.
         * 
         * @return не может быть {@code null}.
         */
        @Nonnull
        List<Date> getWorkTime();
    }

    /**
     * Возвращает список дополнительных профилей сотрудника
     *
     * @return List объектов WorkAddProfile
     * */
    public List<AFWorkProfile> getAllAdditionalProfiles();

    /**
     * Устанавливает аксессор для доступа к идентификатору навигатора.
     * 
     * @see UserMainNavigatorUnidAccessor
     * 
     * @param accessor
     *            - аксессор, не может быть {@code null}.
     */
    void setMainNavigatorUnidAccessor(UserMainNavigatorUnidAccessor accessor);

    /**
     * Whether server logging is enabled or disabled
     * @return true if server logging is enabled
     */
    boolean isServerLoggingEnabled();

    /**
     * Whether console logging is enabled or disabled
     * @return true if console logging is enabled
     */
    boolean isConsoleLoggingEnabled();

    String getSchemeName ();