# Uses of Class
com.orchestranetworks.service.UserReference

Packages that use UserReference
Package
Description
com.onwbp.adaptation
Provides core classes and interfaces for accessing datasets, tables, and their records.
com.orchestranetworks.instance
Provides interfaces for accessing data sets.
com.orchestranetworks.service
Provides classes and interfaces for implementing specific services and access rules on EBX®.
com.orchestranetworks.service.directory
Provides classes for Directory handling.
com.orchestranetworks.ui
This package provides the capability to create custom user interface components that are integrated within EBX®.
com.orchestranetworks.ui.perspective
com.orchestranetworks.ui.view
com.orchestranetworks.workflow
Provides classes and interfaces for implementing workflow processes and invoking them.

- ## Uses of UserReference in com.onwbp.adaptation

  Methods in com.onwbp.adaptation that return UserReference
  Modifier and Type
  Method
  Description
  `UserReference`
  Adaptation.`getCreator()`
  Returns the creator of this dataset or record.
  `UserReference`
  Adaptation.`getLastUser()`
  Returns the last user who modified this dataset or record.

- ## Uses of UserReference in com.orchestranetworks.instance

  Methods in com.orchestranetworks.instance with parameters of type UserReference
  Modifier and Type
  Method
  Description
  `abstract SessionPermissions`
  Repository.`createSessionPermissionsForUser(UserReference aUserReference)`
  Instantiates a permissions evaluator for the specified user without creating a specific session.

- ## Uses of UserReference in com.orchestranetworks.service

  Methods in com.orchestranetworks.service that return UserReference
  Modifier and Type
  Method
  Description
  `static UserReference`
  Profile.`forUser(String aUserId)`
  Returns the specified user reference.
  `static UserReference`
  Profile.`forUserWithSpecificPrivilege(String userId, ServiceKey servicePrivilegeGranted)`
  Returns the user reference specified, with the specific privilege granted.
  `static UserReference`
  Profile.`forUserWithSpecificPrivileges(String userId, Set<ServiceKey> servicePrivileges)`
  Returns the user reference specified, with the specific privileges granted.
  `UserReference`
  Session.`getUserReference()`
  Returns the user's user reference in the directory.
  Methods in com.orchestranetworks.service with parameters of type UserReference
  Modifier and Type
  Method
  Description
  `Adaptation`
  ProcedureContext.`doCreateOccurrence(ValueContext aContent, AdaptationTable aTable, UserReference aCreator, Date aCreationTime, UserReference aLastUpdater, Date aLastUpdateTime)`
  Creates a record in the specified table with the specified system metadata.

- ## Uses of UserReference in com.orchestranetworks.service.directory

  Methods in com.orchestranetworks.service.directory that return UserReference
  Modifier and Type
  Method
  Description
  `UserReference`
  Directory.`authenticateUserFromArray(Object[] args)`
  Authenticates a user using an open array.
  `UserReference`
  DirectoryHandler.`authenticateUserFromArray(Object[] args)`
  `UserReference`
  Directory.`authenticateUserFromHttpRequest(HttpServletRequest request)`
  Authenticates a user for the purpose of a single sign-on policy.
  `UserReference`
  DirectoryHandler.`authenticateUserFromHttpRequest(HttpServletRequest aRequest)`
  `abstract UserReference`
  Directory.`authenticateUserFromLoginPassword(String aLogin, String aPassword)`
  Authenticates a user using the login and password specified.
  `UserReference`
  DirectoryDefault.`authenticateUserFromLoginPassword(String aLogin, String aPassword)`
  `UserReference`
  DirectoryHandler.`authenticateUserFromLoginPassword(String aLogin, String aPassword)`
  `UserReference`
  Directory.`authenticateUserFromSOAPHeader(Element header)`
  Authenticates a user using a SOAP header.
  `UserReference`
  DirectoryHandler.`authenticateUserFromSOAPHeader(Element anHeader)`
  Methods in com.orchestranetworks.service.directory that return types with arguments of type UserReference
  Modifier and Type
  Method
  Description
  `List<UserReference>`
  DirectoryDefault.`getAllUserReferences()`
  Returns all the users defined by this directory.
  `List<UserReference>`
  Directory.`getBackedUpUsers(UserReference aUserReference)`
  Returns the users backed up by the specified user.
  `List<UserReference>`
  DirectoryHandler.`getBackedUpUsers(UserReference aUserReference)`
  If the `Directory` implementation returns `null`, this method returns an empty List.
  `List<UserReference>`
  Directory.`getBackingUpUsers(UserReference aUserReference)`
  Returns the users backing up the specified user.
  `List<UserReference>`
  DirectoryHandler.`getBackingUpUsers(UserReference aUserReference)`
  If the `Directory` implementation returns `null`, this method returns an empty List.
  `List<UserReference>`
  Directory.`getUsersInRole(Role aRole)`
  Returns all users that belong to the specified role.
  `List<UserReference>`
  DirectoryDefault.`getUsersInRole(Role aRole)`
  `List<UserReference>`
  DirectoryHandler.`getUsersInRole(Role aRole)`
  Methods in com.orchestranetworks.service.directory with parameters of type UserReference
  Modifier and Type
  Method
  Description
  `static ProcedureResult`
  DirectoryDefaultHelper.`deleteUser(UserReference aUserReference, String aTrackingInfoOrNull, DirectoryDefault aDirectory)`
  Deletes the user entity corresponding to the specified user reference.
  `String`
  Directory.`displayUser(UserReference aUserReference, Locale aLocale)`
  Returns a label for the specified user.
  `String`
  DirectoryDefault.`displayUser(UserReference aUserReference, Locale aLocale)`
  `String`
  DirectoryHandler.`displayUser(UserReference aUserReference, Locale aLocale)`
  `String`
  Directory.`displayUserWithSalutation(UserReference aUserReference, Locale aLocale)`
  Returns a label for the specified user so that it can be used in the user interface.
  `String`
  DirectoryDefault.`displayUserWithSalutation(UserReference aUserReference, Locale aLocale)`
  `String`
  DirectoryHandler.`displayUserWithSalutation(UserReference aUserReference, Locale aLocale)`
  `static DirectoryDefault.UserEntity`
  DirectoryDefaultHelper.`findUser(UserReference aUserReference, DirectoryDefault aDirectory)`
  Returns the user entity corresponding to the specified user reference if it exists, `null` otherwise.
  `List<UserReference>`
  Directory.`getBackedUpUsers(UserReference aUserReference)`
  Returns the users backed up by the specified user.
  `List<UserReference>`
  DirectoryHandler.`getBackedUpUsers(UserReference aUserReference)`
  If the `Directory` implementation returns `null`, this method returns an empty List.
  `List<UserReference>`
  Directory.`getBackingUpUsers(UserReference aUserReference)`
  Returns the users backing up the specified user.
  `List<UserReference>`
  DirectoryHandler.`getBackingUpUsers(UserReference aUserReference)`
  If the `Directory` implementation returns `null`, this method returns an empty List.
  `List<Role>`
  DirectoryDefault.`getRolesForUser(UserReference userReference)`
  Returns the specific roles of the specified user.
  `URI`
  Directory.`getUserAvatarURI(UserReference aUserReference)`
  Returns the URL to the image associated with the specified user.
  `URI`
  DirectoryDefault.`getUserAvatarURI(UserReference aUserReference)`
  `String`
  Directory.`getUserEmail(UserReference aUserReference)`
  Returns the email address of the specified user, `null` if unknown.
  `String`
  DirectoryDefault.`getUserEmail(UserReference aUserReference)`
  `String`
  DirectoryHandler.`getUserEmail(UserReference aUserReference)`
  `String`
  Directory.`getUserInitials(UserReference aUserReference, Locale aLocale)`
  Returns the initials of the specified user.
  `String`
  DirectoryDefault.`getUserInitials(UserReference aUserReference, Locale aLocale)`
  Returns the initials defined in the user record.
  `abstract boolean`
  Directory.`isUserDefined(UserReference aUserReference)`
  Returns `true` if the specified user actually exists in this directory.
  `boolean`
  DirectoryDefault.`isUserDefined(UserReference aUserReference)`
  `boolean`
  DirectoryHandler.`isUserDefined(UserReference aUserReference)`
  `abstract boolean`
  Directory.`isUserInRole(UserReference aUser, Role aRole)`
  Returns `true` if the user has the specified role.
  `boolean`
  DirectoryDefault.`isUserInRole(UserReference aUserReference, Role aRole)`
  Returns `true` if the user has the specified role.
  `boolean`
  DirectoryHandler.`isUserInRole(UserReference aUser, Role aRole)`
  Returns `true` if the user has the specified role.
  `static DirectoryDefault.UserEntity`
  DirectoryDefaultHelper.`newUser(UserReference aUserReference, DirectoryDefault aDirectory)`
  Returns a new user entity whose key is the specified user reference.

- ## Uses of UserReference in com.orchestranetworks.ui

  Methods in com.orchestranetworks.ui with parameters of type UserReference
  Modifier and Type
  Method
  Description
  `void`
  UIComponentWriter.`addUserAvatar(UserReference aUserReference)`
  Displays the standard user avatar (a circle of 26px diameter with initials or image).

- ## Uses of UserReference in com.orchestranetworks.ui.perspective

  Methods in com.orchestranetworks.ui.perspective with parameters of type UserReference
  Modifier and Type
  Method
  Description
  `Perspective`
  PerspectiveHandler.`getFavoritePerspective(UserReference aUser)`
  Returns the favorite perspective for a given user.
  `Perspective`
  PerspectiveHandler.`getPerspectiveToApply(UserReference aUser)`
  Returns the perspective to apply.
  `Perspective`
  PerspectiveHandler.`getRecommendedPerspective(UserReference aUser)`
  Returns the recommended perspective for a given user.

- ## Uses of UserReference in com.orchestranetworks.ui.view

  Methods in com.orchestranetworks.ui.view with parameters of type UserReference
  Modifier and Type
  Method
  Description
  `Stream<UICustomViewKey>`
  UICustomViewContext.`getCustomViewKeys(AdaptationTable aTable, UserReference aUser)`
  Returns the list of keys of the custom views defined on the given table and applicable by given user

- ## Uses of UserReference in com.orchestranetworks.workflow

  Methods in com.orchestranetworks.workflow that return UserReference
  Modifier and Type
  Method
  Description
  `UserReference`
  CreationWorkItemSpec.`getAllocatedTo()`
  Returns the user to whom the work item must be allocated.
  `UserReference`
  ProcessInstance.`getCreator()`
  Returns the user that created this workflow.
  `UserReference`
  ProcessExecutionInfoContext.`getProcessInstanceCreator()`
  Returns the creator of the current process instance.
  `UserReference`
  ProcessInstanceComment.`getUser()`
  Returns the user who has written the comment.
  `UserReference`
  UserTask.WorkItem.`getUserReference()`
  Returns the owner of the work item.
  `UserReference`
  WorkflowTriggerWorkItemAllocationContext.`getUserReference()`
  Returns the user to whom the work item will be allocated.
  Methods in com.orchestranetworks.workflow that return types with arguments of type UserReference
  Modifier and Type
  Method
  Description
  `List<UserReference>`
  UserTask.`getUsersForAllocation(UserTaskUsersForAllocationCollectorContext aContext)`
  This method is automatically invoked when a workflow administrator clicks the 'allocate' or 'reallocate' administration action of a work item.
  Methods in com.orchestranetworks.workflow with parameters of type UserReference
  Modifier and Type
  Method
  Description
  `void`
  WorkflowEngine.`allocateWorkItem(WorkItemKey aKey, UserReference aUser)`
  Allocates the specified work item to the specified user.
  `static CreationWorkItemSpec`
  CreationWorkItemSpec.`forAllocation(UserReference allocatedTo)`
  Allows to directly create a work item allocated to the specified user.
  `static CreationWorkItemSpec`
  CreationWorkItemSpec.`forAllocationWithPossibleReallocation(UserReference allocatedTo, Role offeredTo)`
  Allows to create a work item allocated to the specified user with the possibility to reallocate it.
  `static CreationWorkItemSpec`
  CreationWorkItemSpec.`forAllocationWithPossibleReallocation(UserReference allocatedTo, Collection<Profile> offeredToProfiles)`
  Allows to create a work item allocated to the specified user with the possibility to reallocate to a profile contained in offeredToProfiles.
  `List<UserTask.WorkItem>`
  WorkflowEngine.`getWorkItemsAllocatedToUser(UserReference aUser)`
  Returns all the work items allocated to a user.
  `List<UserTask.WorkItem>`
  WorkflowEngine.`getWorkItemsOfferedToUser(UserReference aUser)`
  Returns all the work items offered to a user.
  `void`
  WorkflowEngine.`reallocateWorkItem(WorkItemKey aKey, UserReference aUser)`
  Reallocates the specified work item.
  `void`
  ProcessLauncher.`setCreator(UserReference creator)`
  Specifies the creator of the new workflow instance to be launched.
  `void`
  MailSpec.`setUserContext(UserReference user)`
  Defines a specific user for the email context.
  `void`
  WorkflowEngine.`unPublish(PublishedProcessKey publicationKey, boolean forceCurrentInstanceToTerminate, UserReference user)`
  Unpublishes a workflow process publication.