cz.ues.core.role

Interface UESGroup

@UESService
public interface UESGroup

Since:

UES6-10

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_GROUP URI of group business entity.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRoleInterface(UESURI groupRoleUri, UESGroupAddRoleInterface roleInterface) This command creates new role interface connection to the specified role.
void	cancelActivities(UESURI groupRoleUri, UESGroupCancelActivities group) This command cancels activities which exist due to group roles for the specified roles.
UESURI	create(UESURI locationUri, UESGroupCreate group) Creates a new group role.
void	delete(UESURI groupUri) This command deletes the specified group role from the system.
UESGroupAttributes	getAttributes(UESURI groupUri) This command returns attributes representing the group role specified by the groupRoleUri parameter.
UESResultList<UESGroupGetRoleInterfaceListItem,UESGroupGetRoleInterfaceList>	getRoleInterfaceList(UESURI groupRoleUri, UESGroupGetRoleInterfaceList criteria) Returns list of the role interfaces that are connected to the specified group role.
void	propagateActivities(UESURI group, UESGroupPropagateActivities castedRoles) This command propagates activities of the group to its casted roles or casted groups.
void	removeRoleInterface(UESURI groupRoleUri, UESGroupRemoveRoleInterface roleInterface) The command removes role interface connection from the specified group role.
UESURI	setAttributes(UESURI groupUri, UESGroupSetAttributes group) Command for setting attributes of a group role.

Field Detail

BETYPE_GROUP

static final BETYPE_GROUP

URI of group business entity.

Since:

UES6-10

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
UESGroupCreate group)
throws UESGroupRTException

Creates a new group role. The command creates a new group in a specified location. At the very least meta artifact must be specified in UESGroupCreate DTO. Competent role for the new group 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 UESGroupCreate DTO.

Parameters:

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

role - DTO containing attributes of the new group

Returns:

UESURI of the new group

Throws:

UESGroupRTException

Since:

UES6-10

getAttributes

@UESCommand(stereotype=READ)

UESGroupAttributes getAttributes(UESURI groupUri)
throws UESGroupRTException

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

Parameters:

groupUri - UESURI of a group whose attributes are returned

Returns:

DTO containing the group attributes

Throws:

UESGroupRTException

Since:

UES6-10

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI groupUri,
UESGroupSetAttributes group)
throws UESGroupRTException

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

Parameters:

groupUri - UESURI of the group whose attributes are to be changed

group - DTO containing new attributes the group

Returns:

UESURI of the group

Throws:

UESGroupRTException

Since:

UES6-10

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI groupUri)
throws UESGroupRTException

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

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

Parameters:

groupUri - UESURI of the group which is about to be deleted.

Throws:

UESGroupRTException

Since:

UES6-10

propagateActivities

@UESCommand(stereotype=UPDATE)

void propagateActivities(UESURI group,
UESGroupPropagateActivities castedRoles)
throws UESGroupRTException

This command propagates activities of the group to its casted roles or casted groups. Only the active activities are propagated, it means that they have a state and the state must not be final.

Parameters:

group - UESURI of the group which activities will be propagated

castedRoles - UESURIs of the roles which must be casted into group with groupRoleUri and into which the activities will be propagated

Throws:

UESGroupRTException

Since:

UES7-04

cancelActivities

@UESCommand(stereotype=UPDATE)

void cancelActivities(UESURI groupRoleUri,
UESGroupCancelActivities group)
throws UESGroupRTException

This command cancels activities which exist due to group roles for the specified roles.

Parameters:

groupRoleUri - UESURI of the group role with activities

group - DTO containing attributes to canceling activities for casted roles

Throws:

UESGroupRTException

Since:

UES7-08

addRoleInterface

@UESCommand(stereotype=UPDATE)

void addRoleInterface(UESURI groupRoleUri,
UESGroupAddRoleInterface roleInterface)
throws UESGroupRTException

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:

groupRoleUri - UESURI of the group role where the role interface will be connected

roleInterface - DTO containing role interface that to be connected

Throws:

UESGroupRTException

Since:

UES7-10

removeRoleInterface

@UESCommand(stereotype=UPDATE)

void removeRoleInterface(UESURI groupRoleUri,
UESGroupRemoveRoleInterface roleInterface)
throws UESGroupRTException

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

Parameters:

groupRoleUri - UESURI of the group role where the role interface will be disconnected

roleInterface - DTO containing role interface that to be disconnected

Throws:

UESGroupRTException

Since:

UES7-10

getRoleInterfaceList

@UESCommand(stereotype=READ)

UESResultList<UESGroupGetRoleInterfaceListItem,UESGroupGetRoleInterfaceList> getRoleInterfaceList(UESURI groupRoleUri,
UESGroupGetRoleInterfaceList criteria)
throws UESGroupRTException

Returns list of the role interfaces that are connected to the specified group 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:

groupRoleUri - 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 group role

Throws:

UESGroupRTException

Since:

UES7-10

See Also:

UESQuery Documentation.