cz.ues.core.role

Interface UESBasicGroup

@UESService
public interface UESBasicGroup

Since:

UES8-14

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addArtifactInterface(UESURI basicGroupUri, UESBasicGroupAddArtifactInterface addArtifactInterface) Creates new artifact interface connection to the specified role.
UESURI	create(UESURI locationUri, UESBasicGroupCreate basicGroup) Creates a new basic group in a specified location.
void	delete(UESURI basicGroupUri) Deletes the specified basic group role from the system.
UESResultList<UESBasicGroupGetArtifactInterfaceListItem,UESBasicGroupGetArtifactInterfaceList>	getArtifactInterfaceList(UESURI basicGroupUri) Returns sorted list of the codes of artifact interfaces that are connected to the specified basic group.
UESBasicGroupAttributes	getAttributes(UESURI basicGroupUri) Returns attributes representing the basic group specified by the basic_group_uri parameter.
UESResultList<UESBasicGroupAttributes,UESBasicGroupGetBasicGroupList>	getBasicGroupList(UESURI artifactUri, UESBasicGroupGetBasicGroupList criteria) Returns list of the basic groups which are located in the organizational unit of specified artifact.
void	removeArtifactInterface(UESURI basicGroupUri, UESBasicGroupRemoveArtifactInterface removeArtifactInterface) Removes role interface connection from the specified group role.
UESURI	setAttributes(UESURI basicGroupUri, UESBasicGroupSetAttributes basicGroup) Command for setting attributes of a basic group.

Field Detail

BETYPE_BASICGROUP

static final BETYPE_BASICGROUP

URI of basic group business entity.

Since:

UES8-14

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
UESBasicGroupCreate basicGroup)
throws UESBasicGroupRTException

Creates a new basic group in a specified location. If the meta artifact is not selected in UESBasicGroupCreate, the new basic group is created by Basic Group meta artifact from uuOS application. Competent role for the new basic group is always the same role as the competent role for the organizational unit of newly created basic group.

Parameters:

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

basicGroup - Object containing the attributes of the basic group.

Returns:

UESURI of the newly created basic group.

Throws:

UESBasicGroupRTException

Since:

UES8-14

getAttributes

@UESCommand(stereotype=READ)

UESBasicGroupAttributes getAttributes(UESURI basicGroupUri)
throws UESBasicGroupRTException

Returns attributes representing the basic group specified by the basic_group_uri parameter. The command does not change the state of the basic group in the system.

Parameters:

basicGroupUri - UESURI of the basic group whose attributes will be returned.

Returns:

Object containing the attributes of specified basic group.

Throws:

UESBasicGroupRTException

Since:

UES8-14

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI basicGroupUri,
UESBasicGroupSetAttributes basicGroup)
throws UESBasicGroupRTException

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

Parameters:

basicGroupUri - UESURI of the basic group whose attributes will be modified.

basicGroup - Object containing the changed attributes of the basic group.

Returns:

UESURI of the basic group.

Throws:

UESBasicGroupRTException

Since:

UES8-14

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI basicGroupUri)
throws UESBasicGroupRTException

Deletes the specified basic group role from the system. The basic group is deleted even if it contains a locked sheet or attachment. The basic group cannot be deleted if: the basic group is in an active cast, the basic group's workflow is not created, a property contains a reference to this basic group, a time sheet exists with a reference to this basic group, the basic_group_type attribute's value is "AUTHORITIES" or "AUDITORS".

Parameters:

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

Throws:

UESBasicGroupRTException

Since:

UES8-14

addArtifactInterface

@UESCommand(stereotype=UPDATE)

void addArtifactInterface(UESURI basicGroupUri,
UESBasicGroupAddArtifactInterface addArtifactInterface)
throws UESBasicGroupRTException

Creates new artifact interface connection to the specified role.

Parameters:

basicGroupUri - UESURI of the basic group where the artifact interface will be connected.

artifactInterface - Object containing the artifact interface code that is to be connected.

Throws:

UESBasicGroupRTException

Since:

UES8-14

removeArtifactInterface

@UESCommand(stereotype=UPDATE)

void removeArtifactInterface(UESURI basicGroupUri,
UESBasicGroupRemoveArtifactInterface removeArtifactInterface)
throws UESBasicGroupRTException

Removes role interface connection from the specified group role. Only connected interfaces can be disconnected from the group role.

Parameters:

basicGroupUri - UESURI of the basic group where the artifact interface will be disconnected.

artifactInterface - Object containing the artifact interface code that is to be disconnected.

Throws:

UESBasicGroupRTException

Since:

UES8-14

getArtifactInterfaceList

@UESCommand(stereotype=READ)

UESResultList<UESBasicGroupGetArtifactInterfaceListItem,UESBasicGroupGetArtifactInterfaceList> getArtifactInterfaceList(UESURI basicGroupUri)
throws UESBasicGroupRTException

Returns sorted list of the codes of artifact interfaces that are connected to the specified basic group.

Parameters:

basicGroupUri - UESURI of the basic group for which the codes of connected artifact interfaces are to be listed.

Returns:

The list of objects containing the codes of artifact interfaces.

Throws:

UESBasicGroupRTExceptionr

UESBasicGroupRTException

Since:

UES8-14

getBasicGroupList

@UESCommand(stereotype=READ)

UESResultList<UESBasicGroupAttributes,UESBasicGroupGetBasicGroupList> getBasicGroupList(UESURI artifactUri,
UESBasicGroupGetBasicGroupList criteria)
throws UESBasicGroupRTException

Returns list of the basic groups which are located in the organizational unit of specified artifact. The list of the returned basic groups can be filtered and ordered arbitrarily. The parameters available for customized filtering and ordering are the following: name, code, basic_group_type. The list is sorted by name of the basic group by default.

Parameters:

artifactUri - UESURI of an existing artifact. Basic groups from the organizational unit where the artifact is located will be returned.

Returns:

The list of basic groups which are located in the same organizational unit as specified artifact.

Throws:

UESBasicGroupRTException

Since:

UES8-14