UserSearchParams (ARTA Synergy API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

arta.synergy.web.common.client.data.person
Class UserSearchParams

java.lang.Object
  arta.synergy.web.common.client.data.person.SearchParams
      arta.synergy.web.common.client.data.person.UserSearchParams

All Implemented Interfaces:: java.io.Serializable

public class UserSearchParams
extends SearchParams
extends SearchParams

Created by IntelliJ IDEA.
User: topa
Date: 04.05.2010
Time: 12:04:08
Класс с параметрами поиска пользователей
Если вы добавляете или изменяете параметры здесь имейте ввиду, что нужно внести соответствующие изменения в класс с параметрами поиска часто выбираемых пользователей

See Also:: ChosenUsersSearchParams, Serialized Form

Nested Class Summary
`static class`	`UserSearchParams.AdditionalFields` Дополнительные поля, которые могут быть опционально подгружены для каждого пользователя
`static class`	`UserSearchParams.AdditionalParams` Дополнительные параметры.

Field Summary
`java.util.HashMap<java.lang.String,java.lang.String>`	`customParameters` перечень дополнительных параметров со значениями,которые могут понадобится для получения дополнительных полей.
`int`	`groupID` идентификатор группы.
`int`	`levelsCount` Количество уровней "вниз" по оргструктуре от данного пользователя
`int`	`operationType` Тип действия Если данный параметр задан, то список пользователей будет подгружаться не только от имени actorID, но и от имени тех пользователей, которые делегировали ему право на operationType Пример: используется в диалоге создания работы в полях исполнитель, соисполнители.
`int`	`ownerOperationType` Тип действия Если данный параметр задан, то список пользователей в выборке ограничивается теми пользователями, которые делегировали actorID право на ownerOperationType и самим actorID.
`int`	`upLevelsCount` Количество уровней "вверх" по орг структуре, от пользователя actorID
`static java.lang.String`	`USER_NAME_DEFAULT_TYPE` дефолтный тип отображения имени пользователя
`static java.lang.String`	`USER_NAME_FULL` Отображение полного имени пользователя
`static java.lang.String`	`USER_NAME_SHORT` Отображение фамилии и инициалов

Fields inherited from class arta.synergy.web.common.client.data.person.SearchParams
`countInPart, pageNumber, pagesCount`

Constructor Summary
`UserSearchParams()`

Method Summary
`void`	`addCustomField(java.lang.String fieldName)`
`boolean`	`containsCustomField(java.lang.String fieldName)` Проверяет есть ли среди дополнительных полей поле fieldName
`java.lang.String`	`getActorID()`
`java.util.Iterator<java.lang.String>`	`getCustomFields()`
`java.lang.String`	`getDepartmentID()`
`java.lang.String`	`getFilterDepartmentID()`
`java.lang.String`	`getFilterPositionID()`
`int`	`getPositionType()`
`int`	`getRecordsCount()`
`java.lang.String`	`getSearch()`
`int`	`getStartRecord()`
`java.lang.String`	`getUserNameDisplayType()`
`java.util.ArrayList<java.lang.String>`	`getUsersToCheck()`
`boolean`	`isManagedUsers()`
`boolean`	`isShowAll()`
`boolean`	`isShowNoPosition()`
`void`	`setActorID(java.lang.String actorID)`
`void`	`setDepartmentID(java.lang.String departmentID)`
`void`	`setFilterDepartmentID(java.lang.String filterDepartmentID)`
`void`	`setFilterPositionID(java.lang.String filterPositionID)`
`void`	`setManagedUsers(boolean isManagedUsers)`
`void`	`setPositionType(int positionType)`
`void`	`setRecordsCount(int recordsCount)`
`void`	`setSearch(java.lang.String search)`
`void`	`setShowAll(boolean showAll)`
`void`	`setShowNoPosition(boolean showNoPosition)`
`void`	`setStartRecord(int startRecord)`
`void`	`setUserNameDisplayType(java.lang.String userNameDisplayType)`
`void`	`setUsersToCheck(java.util.ArrayList<java.lang.String> usersToCheck)`

Methods inherited from class arta.synergy.web.common.client.data.person.SearchParams
`getCountInPart, getLastPageNumber, getLimit, getNextPageNumber, getPageNumber, getPagesCount, getPreviousPageNumber, setCountInPart, setPageNumber, setPagesCount, toFirstPage, toLastPage, toNextPage, toPreviousPage`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

USER_NAME_FULL

public static final java.lang.String USER_NAME_FULL

Отображение полного имени пользователя

See Also:: Constant Field Values

USER_NAME_SHORT

public static final java.lang.String USER_NAME_SHORT

Отображение фамилии и инициалов

See Also:: Constant Field Values

USER_NAME_DEFAULT_TYPE

public static final java.lang.String USER_NAME_DEFAULT_TYPE

дефолтный тип отображения имени пользователя

See Also:: Constant Field Values

levelsCount

public int levelsCount

Количество уровней "вниз" по оргструктуре от данного пользователя

See Also:: actorID

upLevelsCount

public int upLevelsCount

Количество уровней "вверх" по орг структуре, от пользователя actorID

See Also:: actorID

customParameters

public java.util.HashMap<java.lang.String,java.lang.String> customParameters

перечень дополнительных параметров со значениями,которые могут понадобится для получения дополнительных полей.

See Also:: UserSearchParams.AdditionalParams

operationType

public int operationType

Тип действия

Если данный параметр задан, то список пользователей будет подгружаться не только от имени actorID, но и от имени тех пользователей, которые делегировали ему право на operationType

Пример: используется в диалоге создания работы в полях исполнитель, соисполнители. Пользователь может выбрать в качестве исполнителя не только своего подчиненного, но и подчиненных для пользователей, которые делегировали ему право на создание работы

ownerOperationType

public int ownerOperationType

Тип действия

Если данный параметр задан, то список пользователей в выборке ограничивается теми пользователями, которые делегировали actorID право на ownerOperationType и самим actorID.

Пример: используется в диалоге создания работы для поля "автор". Если пользователю кто-то делегировал право на создание работы, то в список пользователей должен содержать самого пользователя и тех, кто ему делегировал это право

groupID

public int groupID

идентификатор группы. Если параметр задан в чузер подтягиваются пользователи, входящие в данную группу

Constructor Detail