cz.ues.core.role

Interface UESAccessRole

@UESService
public interface UESAccessRole

Since:

UES7-10

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
void	activateAccess(UESURI accessRoleUri) This command activates an access role.
void	addRoleInterface(UESURI accessRoleUri, UESAccessRoleAddRoleInterface roleInterface) This command creates new role interface connection to the specified access role.
UESURI	create(UESURI locationUri, UESAccessRoleCreate accessRole) Creates a new access role.
void	deactivateAccess(UESURI accessRoleUri) This command deactivates an access role.
UESResultList<UESAccessRoleAttributes,UESAccessRoleGetList>	getAccessRoleList(UESURI territoryUri, UESAccessRoleGetList criteria) Returns list of personal access roles in the given location with specified criteria.
UESAccessRoleAttributes	getAttributes(UESURI accessRoleUri) This command returns attributes representing the personal access role specified by the accessRoleUri parameter.
UESResultList<UESAccessRoleGetRoleInterfaceListItem,UESAccessRoleGetRoleInterfaceList>	getRoleInterfaceList(UESURI accessRoleUri, UESAccessRoleGetRoleInterfaceList criteria) Returns list of the role interfaces that are connected to the specified access role.
void	removeRoleInterface(UESURI accessRoleUri, UESAccessRoleRemoveRoleInterface roleInterface) The command removes role interface connection from the specified access role.
UESURI	setAttributes(UESURI accessRoleUri, UESAccessRoleSetAttributes accessRole) Command for setting attributes of an access role.

Field Detail

BETYPE_ACCESSROLE

static final BETYPE_ACCESSROLE

URI of access role business entity.

Since:

UES7-10

Method Detail

getAttributes

@UESCommand(stereotype=READ)

UESAccessRoleAttributes getAttributes(UESURI accessRoleUri)
throws UESAccessRoleRTException

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

Parameters:

accessRoleUri - UESURI of a personal access role whose attributes are returned

Returns:

DTO containing the personal access role attributes

Throws:

UESAccessRoleRTException

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI accessRoleUri,
UESAccessRoleSetAttributes accessRole)
throws UESAccessRoleRTException

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

Parameters:

accessRoleUri - UESURI of the access role whose attributes are to be changed

accessRole - DTO containing new attributes the access role

Returns:

UESURI of the access role

Throws:

UESAccessRoleRTException

Since:

UES7-10

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
UESAccessRoleCreate accessRole)
throws UESAccessRoleRTException

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

Parameters:

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

DTO - containing attributes of the new access role

Returns:

UESURI of the new access role

Throws:

UESAccessRoleRTException

Since:

UES7-10

getRoleInterfaceList

@UESCommand(stereotype=READ)

UESResultList<UESAccessRoleGetRoleInterfaceListItem,UESAccessRoleGetRoleInterfaceList> getRoleInterfaceList(UESURI accessRoleUri,
UESAccessRoleGetRoleInterfaceList criteria)
throws UESAccessRoleRTException

Returns list of the role interfaces that are connected to the specified access role. The list of returned interfaces could be filtered by the name or code. Returned list does not contain any objects filtered out by executed UESQuery. The list is sorted by the name (and by code in case are equal) of an interface by default.

Parameters:

accessRoleUri - UESURI of the access role for which the connected role interfaces are to be listed

criteria - DTO containing criteria for listing access role interfaces. Available parameters are: name and code

Returns:

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

Throws:

UESAccessRoleRTException

Since:

UES7-10

See Also:

UESQuery Documentation.

removeRoleInterface

@UESCommand(stereotype=UPDATE)

void removeRoleInterface(UESURI accessRoleUri,
UESAccessRoleRemoveRoleInterface roleInterface)
throws UESAccessRoleRTException

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

Parameters:

accessRoleUri - UESURI of the access role where the role interface will be disconnected

roleInterface - DTO containing role interface that to be disconnected

Throws:

UESAccessRoleRTException

Since:

UES7-10

addRoleInterface

@UESCommand(stereotype=UPDATE)

void addRoleInterface(UESURI accessRoleUri,
UESAccessRoleAddRoleInterface roleInterface)
throws UESAccessRoleRTException

This command creates new role interface connection to the specified access 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:

accessRoleUri - UESURI of the access role where the role interface will be connected

roleInterface - DTO containing role interface that to be connected

Throws:

UESAccessRoleRTException

Since:

UES7-10

getAccessRoleList

@UESCommand(stereotype=READ)

UESResultList<UESAccessRoleAttributes,UESAccessRoleGetList> getAccessRoleList(UESURI territoryUri,
UESAccessRoleGetList criteria)
throws UESAccessRoleRTException

Returns list of personal access roles in the given location with specified criteria.

Parameters:

territoryUri - Never null. UESURI of the territory, from which the access roles will be retrieved.

criteria - Object containing paging and filtering criteria.

Returns:

List of personal access roles in the territory. Contains instances of UESAccessRoleAttributes.

Throws:

UESAccessRoleRTException

Since:

UES8-08

deactivateAccess

@UESCommand(stereotype=UPDATE)

void deactivateAccess(UESURI accessRoleUri)
throws UESAccessRoleRTException

This command deactivates an access role. The access role will lose access to its territory.

Parameters:

accessRoleUri - UESURI of an access role that the access will be canceled.

Throws:

UESAccessRoleRTException

Since:

UES7-10

activateAccess

@UESCommand(stereotype=UPDATE)

void activateAccess(UESURI accessRoleUri)
throws UESAccessRoleRTException

This command activates an access role. The access role will have access to its territory.

Parameters:

accessRoleUri - UESURI of an access role that the access will be reactivated.

Throws:

UESAccessRoleRTException

Since:

UES7-10