cz.ues.core.personalrole

Interface UESPersonalRole

@UESService
public interface UESPersonalRole

Since:

UES6-06

Method Summary

Methods

Modifier and Type	Method and Description
UESPersonalRoleArtifactPresentationAttributes	getArtifactPresentationAttributes(UESURI personalRoleUri) Retrieves user settings of artifact presentation.
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	setArtifactPresentationAttributes(UESURI personalRoleUri, UESPersonalRoleSetArtifactPresentationAttributes attributes) Configures user settings of artifact presentation.
UESURI	setProfileAttributes(UESURI personalRoleUri, UESProfileSetAttributes profile) Sets user's profile attributes.

Method Detail

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