cz.ues.core.personalrole

Interface UESPersonalRole

@UESService
public interface UESPersonalRole

Since:

UES6-06

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_PERSONALROLE URI of PersonalRole business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI locationUri, UESPersonalRoleCreate personalRole) Creates a new Personal Role to a specified location.
java.util.List<UESPersonalRoleAccountAttributes>	getAccountList(UESURI personalRoleUri) Returns list of accounts for an user.
UESPersonalRoleArtifactPresentationAttributes	getArtifactPresentationAttributes(UESURI personalRoleUri) Retrieves user settings of artifact presentation.
UESPersonalRoleAttributes	getAttributes(UESURI personalRoleURI) This command returns attributes representing the personalRole specified by the personalRoleURI parameter.
UESProfileAttributes	getProfileAttributes(UESURI personalRoleUri) This command returns profile information of the user.
UESResultList<UESTerritoryAttributes,UESPersonalRoleGetTerritoryList>	getTerritoryList(UESURI personalRoleUri, UESPersonalRoleGetTerritoryList criteria) This command returns a list of territories the personal role has access to.
UESURI	relocate(UESURI personalRoleUri, UESPersonalRoleRelocate personalRole) Relocates a Personal Role between two territories within the same Territory Container.
void	removeAccount(UESURI personalRoleUri, UESPersonalRoleRemoveAccount attributes) Removes account.
UESURI	setAccessCodes(UESURI personalRoleUri, UESPersonalRoleSetAccessCodes setAccessCodes) Command for setting Access Codes of an personalRole.
UESURI	setArtifactPresentationAttributes(UESURI personalRoleUri, UESPersonalRoleSetArtifactPresentationAttributes attributes) Configures user settings of artifact presentation.
UESURI	setAttributes(UESURI personalRoleUri, UESPersonalRoleSetAttributes personalRole) Command for setting attributes of an personalRole.
UESURI	setProfileAttributes(UESURI personalRoleUri, UESProfileSetAttributes profile) Sets user's profile attributes.

Field Detail

BETYPE_PERSONALROLE

static final BETYPE_PERSONALROLE

URI of PersonalRole business entity.

Since:

UES8-23

Method Detail

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI personalRoleUri,
UESPersonalRoleSetAttributes personalRole)
throws UESPersonalRoleRTException

Command for setting attributes of an personalRole. The command can't modify references to objects like location, competent role and so on.

Parameters:

personalRoleUri - UESURI of the Personal Role whose attributes are to be changed

personalRole - DTO containing new attributes the personalRole

Returns:

UESURI of the PersonalRole

Throws:

UESPersonalRoleRTException

Since:

UES8-23

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
UESPersonalRoleCreate personalRole)
throws UESPersonalRoleRTException

Creates a new Personal Role to a specified location.

Parameters:

locationUri - UESURI of OU or folder in which the PersonalRole will be created.

personalRole - DTO containing the attributes of the PersonalRole.

Returns:

UESURI of the new PersonalRole.

Throws:

UESPersonalRoleRTException

Since:

UES8-23

getAttributes

@UESCommand(stereotype=READ)

UESPersonalRoleAttributes getAttributes(UESURI personalRoleURI)
throws UESPersonalRoleRTException

This command returns attributes representing the personalRole specified by the personalRoleURI parameter. The command does not change the state of the personalRole in the system.

Parameters:

personalRoleURI - UESURI of a personalRole whose attributes are returned

Returns:

DTO containing the personalRole attributes

Throws:

UESPersonalRoleRTException

Since:

UES8-23

setAccessCodes

@UESCommand(stereotype=UPDATE)

UESURI setAccessCodes(UESURI personalRoleUri,
UESPersonalRoleSetAccessCodes setAccessCodes)
throws UESPersonalRoleRTException

Command for setting Access Codes of an personalRole.

Parameters:

personalRoleUri - UESURI of the Personal Role whose access codes are to be changed

setAccessCodes - UESPersonalRoleSetAccessCodes DTO containing new Access Code 1 and 2.

Returns:

UESURI of the PersonalRole

Throws:

UESPersonalRoleRTException

Since:

UES8-23

getTerritoryList

@UESCommand(stereotype=READ)

UESResultList<UESTerritoryAttributes,UESPersonalRoleGetTerritoryList> getTerritoryList(UESURI personalRoleUri,
UESPersonalRoleGetTerritoryList criteria)
throws UESPersonalRoleRTException

This command returns a list of territories the personal role has access to. The command does not return all territories, only a sublist. The list of returned territories can be filtered by the name, code or type of an territory. The list is sorted by names (and codes in case two names are equal) by default, or it can be sorted arbitrarily.

Parameters:

personalRoleUri - UESURI of the personal role whose territories are listed.

criteria - DTO containing criteria for listing territories. Available parameters are: name, code, preferred and type : UESTerritoryType.

Returns:

List of DTO representing territories.

Throws:

UESPersonalRoleRTException

Since:

UES6-06

See Also:

UESQuery Documentation.

getProfileAttributes

@UESCommand(stereotype=READ)

UESProfileAttributes getProfileAttributes(UESURI personalRoleUri)
throws UESPersonalRoleRTException

This command returns profile information of the user.

Parameters:

personalRoleUri - UESURI of the personal role whose profile attributes are returned.

Returns:

DTO representing user's profile data.

Throws:

UESPersonalRoleRTException

Since:

UES6-06

setProfileAttributes

@UESCommand(stereotype=UPDATE)

UESURI setProfileAttributes(UESURI personalRoleUri,
UESProfileSetAttributes profile)
throws UESPersonalRoleRTException

Sets user's profile attributes.

Parameters:

personalRoleUri - UESURI of the personal role which represents the user and for which the language settings are modified. Never null.

profile - Object containing personal profile attributes, contained language can be null.

Returns:

Returns UESURI of the personal role, for which was the language settings modified.

Throws:

UESPersonalRoleRTException

Since:

UES8-07

setArtifactPresentationAttributes

@UESCommand(stereotype=UPDATE)

UESURI setArtifactPresentationAttributes(UESURI personalRoleUri,
UESPersonalRoleSetArtifactPresentationAttributes attributes)
throws UESPersonalRoleRTException

Configures user settings of artifact presentation. User will see artifacts according to this configuration. Presentation of artifact can be affected by these attributes: artifact width, header mode (two lines, one line, none), control bar visibility, artifact header sticking, context menu mode (advanced, simple). When viewing an artifact, presentation settings are looked up in the following order: User settings, artifact presentation settings, meta artifact template presentation settings, and layout artifact, if it is configured, or default system settings otherwise.

Parameters:

personalRoleUri - UESURI of the personal role whose profile attributes are to be configured.

attributes - DTO of presentation attributes

Throws:

UESPersonalRoleRTException

Since:

UES8-03

getArtifactPresentationAttributes

@UESCommand(stereotype=READ)

UESPersonalRoleArtifactPresentationAttributes getArtifactPresentationAttributes(UESURI personalRoleUri)
throws UESPersonalRoleRTException

Retrieves user settings of artifact presentation. User will see artifacts according to this configuration. Presentation of artifact can be affected by these attributes: artifact width, header mode (two lines, one line, none), control bar visibility, artifact header sticking, context menu mode (advanced, simple). When viewing an artifact, presentation settings are looked up in the following order: User settings, artifact presentation settings, meta artifact template presentation settings, and layout artifact, if it is configured, or default system settings otherwise.

Parameters:

personalRoleUri - UESURI of the personal role whose profile attributes are to be retrieved.

Returns:

UESPersonalRoleArtifactPresentationAttributes DTO of user settings of artifact presentation

Throws:

UESPersonalRoleRTException

Since:

UES8-03

relocate

@UESCommand(stereotype=UPDATE)

UESURI relocate(UESURI personalRoleUri,
UESPersonalRoleRelocate personalRole)
throws UESPersonalRoleRTException, UESArtifactRTException

Relocates a Personal Role between two territories within the same Territory Container. It is not possible to relocate a Personal Role within the same territory or across Territory Containers. To relocate a Personal Role, it is necessary to have permissions to move the selected Personal Role and insert it into the selected location according to the selected meta artifact. Note that attributes related to authorization and structure are not preserved when relocating the Personal Role and their value is evaluated the same way as when creating a new Personal Role.

Parameters:

personalRoleUri - UESURI of a Personal Role to relocate.

personalRole - Object containing a new location and modified attributes of the Personal Role.

Returns:

UU::OS::UESURI - UESURI of the relocated Personal Role.

Throws:

UESPersonalRoleRTException, - UESArtifactRTException

UESPersonalRoleRTException

UESArtifactRTException

Since:

UES8-23

getAccountList

@UESCommand(stereotype=READ)

java.util.List<UESPersonalRoleAccountAttributes> getAccountList(UESURI personalRoleUri)
throws UESPersonalRoleRTException

Returns list of accounts for an user.

Parameters:

personalRoleUri - identifies the user for which are accounts retrieved

Returns:

list of accounts

Throws:

UESPersonalRoleRTException - if the personalRoleUri parameter is either null

Since:

UES8-23

removeAccount

@UESCommand(stereotype=DELETE)

void removeAccount(UESURI personalRoleUri,
UESPersonalRoleRemoveAccount attributes)
throws UESPersonalRoleRTException

Removes account.

Parameters:

personalRoleUri - identifies the user for which is the account removed

attributes - this parameter specifies the account to be deleted

Throws:

UESPersonalRoleRTException - if the personalRoleUri parameter is either null or there is no account which conforms to constraints specified in attributes parameter

Since:

UES8-23