cz.ues.core.role

Interface UESRole

@UESService
public interface UESRole

Since:

UES6-06

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_ROLE URI of role business entity.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRoleInterface(UESURI roleUri, UESRoleAddRoleInterface roleInterface) This command creates new role interface connection to the specified role.
UESURI	create(UESURI locationUri, UESRoleCreate role) Creates a new role.
void	delete(UESURI roleUri) This command deletes the specified role from the system.
UESResultList<UESRoleGetArtifactListItem,UESRoleGetArtifactList>	getArtifactList(UESURI roleUri, UESRoleGetArtifactList criteria) This command returns a list of entries representing the artifacts for that the specified role is competent.
UESRoleAttributes	getAttributes(UESURI roleUri) This command returns attributes representing the role specified by the roleUri parameter.
UESResultList<UESRoleGetRoleInterfaceListItem,UESRoleGetRoleInterfaceList>	getRoleInterfaceList(UESURI roleUri, UESRoleGetRoleInterfaceList criteria) Returns list of the role interfaces that are connected to the specified role.
void	removeRoleInterface(UESURI roleUri, UESRoleRemoveRoleInterface roleInterface) The command removes role interface connection from the specified role.
UESURI	setAttributes(UESURI roleUri, UESRoleSetAttributes role) Command for setting attributes of a role.

Field Detail

BETYPE_ROLE

static final BETYPE_ROLE

URI of role business entity.

Since:

UES6-06

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
UESRoleCreate role)
throws UESRoleRTException

Creates a new role. The command creates a new role in a specified location. At the very least meta artifact must be specified in UESRoleCreate DTO. Competent role for the new role will be selected as the most suitable according to specified container and meta artifact (executive/authorized role with connected interface), or can be also specified in UESRoleCreate DTO.

Parameters:

locationUri - UESURI of the folder/org. unit/meta model where the role will be created.

role - DTO containing attributes of the new role

Returns:

UESURI of the new role

Throws:

UESRoleRTException

Since:

UES6-06

getAttributes

@UESCommand(stereotype=READ)

UESRoleAttributes getAttributes(UESURI roleUri)
throws UESRoleRTException

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

Parameters:

roleUri - UESURI of the role

Returns:

DTO with role attributes.

Throws:

UESRoleRTException

Since:

UES6-06

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI roleUri,
UESRoleSetAttributes role)
throws UESRoleRTException

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

Parameters:

roleUri - UESURI of the role whose attributes are to be changed

role - DTO containing new attributes for the role

Returns:

UESURI of the role

Throws:

UESRoleRTException

Since:

UES6-06

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI roleUri)
throws UESRoleRTException

This command deletes the specified role from the system. The role is deleted even if it contains a locked sheet or attachment. The role cannot be deleted when:

• the role is not in an active cast.
• the role's workflow is not created
• a property contains a reference to this role
• a time sheet exists with a reference to this role
• an artifact exists with this role as competent role
• an activity exists with this role as competent role

Parameters:

roleUri - UESURI of the role which is about to be deleted.

Throws:

UESRoleRTException

Since:

UES6-10

getArtifactList

@UESCommand(stereotype=READ)

UESResultList<UESRoleGetArtifactListItem,UESRoleGetArtifactList> getArtifactList(UESURI roleUri,
UESRoleGetArtifactList criteria)
throws UESArtifactSearchRTException

This command returns a list of entries representing the artifacts for that the specified role is competent. The list is sorted by the name (and codes in case are equal) of a entry by default.

Parameters:

roleUri - UESURI of the role that is competent for the searched artifacts

criteria - DTO containing criteria for listing role's artifacts.

Returns:

List of DTO representing artifacts for that the specified role is competent.

Throws:

UESArtifactSearchRTException

Since:

UES7-06

addRoleInterface

@UESCommand(stereotype=UPDATE)

void addRoleInterface(UESURI roleUri,
UESRoleAddRoleInterface roleInterface)
throws UESRoleRTException

This command creates new role interface connection to the specified role. The role interface has to be in an active state and mustn't be already connected. The role interface has to be connected to the one of the authorized roles for this command, or the authorized role has to be casted to the default group of meta model where the role interface is located.

Parameters:

roleUri - UESURI of the role where the role interface will be connected

roleInterface - DTO containing role interface that to be connected

Throws:

UESRoleRTException

Since:

UES7-10

removeRoleInterface

@UESCommand(stereotype=UPDATE)

void removeRoleInterface(UESURI roleUri,
UESRoleRemoveRoleInterface roleInterface)
throws UESRoleRTException

The command removes role interface connection from the specified role. Only connected interfaces can be disconnected from role.

Parameters:

roleInterfaceUri - UESURI of the role where the role interface will be disconnected.

roleInterface - DTO containing role interface that to be disconnected

Throws:

UESRoleRTException

Since:

UES7-10

getRoleInterfaceList

@UESCommand(stereotype=READ)

UESResultList<UESRoleGetRoleInterfaceListItem,UESRoleGetRoleInterfaceList> getRoleInterfaceList(UESURI roleUri,
UESRoleGetRoleInterfaceList criteria)
throws UESRoleRTException

Returns list of the role interfaces that are connected to the specified role. Returned list does not contain any objects filtered out by executed UESQuery. See Also: UES Query Documentation

Parameters:

roleUri - UES URI of the role for which the connected role interfaces are to be listed

criteria - DTO containing criteria for listing connected role interfaces

Returns:

List of DTO representing role interfaces which are connected to the specified role

Throws:

UESRoleRTException

Since:

UES7-10