cz.ues.core.role

Interface UESRoleInterface

@UESService
public interface UESRoleInterface

Since:

UES7-10

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BEROLE_INTERFACE_CODE Code of role interface business entity.
static UESURI	BETYPE_ROLE_INTERFACE URI of role interface business entity.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMetaArtifact(UESURI roleInterfaceUri, UESRoleInterfaceAddMetaArtifact metaArtifact) The command creates new meta artifact connection to the specified role interface.
UESURI	create(UESURI locationUri, UESRoleInterfaceCreate roleInterface) Creates a new role interface.
void	delete(UESURI roleInterfaceUri) This command deletes the specified role interface from the system.
UESURI	export(UESURI roleInterfaceUri, UESRoleInterfaceExport roleInterface) The command exports a role interface to a DataFile, which is saved to the Export Storage.
UESRoleInterfaceAttributes	getAttributes(UESURI roleInterfaceUri) This command returns attributes representing the role interface specified by the roleInterfaceUri parameter.
UESStreamHandler	getExportData(UESURI roleInterfaceUri, UESRoleInterfaceGetExportData roleInterface) The command returns a data file generated by the export command.
UESResultList<UESRoleInterfaceGetMetaArtifactListItem,UESRoleInterfaceGetMetaArtifactList>	getMetaArtifactList(UESURI roleInterfaceUri, UESRoleInterfaceGetMetaArtifactList criteria) Returns list of the meta artifacts that are connected to the specified role interface.
UESResultList<UESRoleInterfaceGetRoleListItem,UESRoleInterfaceGetRoleList>	getRoleList(UESURI roleInterfaceUri, UESRoleInterfaceGetRoleList criteria) Returns list of roles, which the specified role interface is connected to.
void	removeMetaArtifact(UESURI roleInterfaceUri, UESRoleInterfaceRemoveMetaArtifact metaArtifact) The command removes meta artifact connection from the specified role interface.
UESURI	setAttributes(UESURI roleInterfaceUri, UESRoleInterfaceSetAttributes roleInterface) Command for setting attributes of a role interface.

Field Detail

BEROLE_INTERFACE_CODE

static final BEROLE_INTERFACE_CODE

Code of role interface business entity.

See Also:

Constant Field Values

BETYPE_ROLE_INTERFACE

static final BETYPE_ROLE_INTERFACE

URI of role interface business entity.

Since:

UES7-10

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
UESRoleInterfaceCreate roleInterface)
throws UESRoleInterfaceRTException

Creates a new role interface. The command creates a new role interface in a specified meta model dictionary. At the very least meta artifact, name and code must be specified in UESRoleInterfaceCreate 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 UESRoleInterfaceCreate DTO.

Parameters:

locationUri - UESURI of the meta model dictionary where the role interface will be created.

roleInterface - DTO containing attributes of the new role interface.

Returns:

UESURI of the new role interface

Throws:

UESRoleInterfaceRTException

Since:

UES7-10

getAttributes

@UESCommand(stereotype=READ)

UESRoleInterfaceAttributes getAttributes(UESURI roleInterfaceUri)
throws UESRoleInterfaceRTException

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

Parameters:

roleInterfaceUri - UESURI of a role interface whose attributes are returned

Returns:

DTO containing the role interface attributes

Throws:

UESRoleInterfaceRTException

Since:

UES7-10

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI roleInterfaceUri,
UESRoleInterfaceSetAttributes roleInterface)
throws UESRoleInterfaceRTException

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

Parameters:

roleInterfaceUri - UESURI of the role interface whose attributes are to be changed

roleInterface - DTO containing new attributes the role interface

Returns:

UESURI of the role interface

Throws:

UESRoleInterfaceRTException

Since:

UES7-10

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI roleInterfaceUri)
throws UESRoleInterfaceRTException

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

• the role interface's workflow is not created
• a property contains a reference to this role interface
• a time sheet exists with a reference to this role interface

Parameters:

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

Throws:

UESRoleInterfaceRTException

Since:

UES7-10

addMetaArtifact

@UESCommand(stereotype=UPDATE)

void addMetaArtifact(UESURI roleInterfaceUri,
UESRoleInterfaceAddMetaArtifact metaArtifact)
throws UESRoleInterfaceRTException

The command creates new meta artifact connection to the specified role interface.

Parameters:

roleInterfaceUri - UESURI of the role interface where the meta artifacts will be connected

metaArtifact - DTO containing meta artifact that to be connected

Throws:

UESRoleInterfaceRTException

Since:

UES7-10

removeMetaArtifact

@UESCommand(stereotype=UPDATE)

void removeMetaArtifact(UESURI roleInterfaceUri,
UESRoleInterfaceRemoveMetaArtifact metaArtifact)
throws UESRoleInterfaceRTException

The command removes meta artifact connection from the specified role interface. Only connected meta artifacts can be disconnected from the role interface.

Parameters:

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

metaArtifact - DTO containing meta artifact that to be disconnected

Throws:

UESRoleInterfaceRTException

Since:

UES7-10

getMetaArtifactList

@UESCommand(stereotype=READ)

UESResultList<UESRoleInterfaceGetMetaArtifactListItem,UESRoleInterfaceGetMetaArtifactList> getMetaArtifactList(UESURI roleInterfaceUri,
UESRoleInterfaceGetMetaArtifactList criteria)

Returns list of the meta artifacts that are connected to the specified role interface. Returned list does not contain any objects filtered out by executed UESQuery. The list of returned meta artifacts could be filtered by the name or code. The list is sorted by the name (and codes in case are equal). See the UES query documentation for more information.

Parameters:

roleInterfaceUri - UES URI of the role interface for which the connected meta artifacts are to be listed

criteria - DTO containing criteria for listing connected meta artifacts. Available parameters are: name and code

Returns:

List of DTO representing meta artifacts which are connected to the specified role interface

Since:

UES7-10

See Also:

UESQuery Documentation.

export

UESURI export(UESURI roleInterfaceUri,
UESRoleInterfaceExport roleInterface)
throws UESRoleInterfaceRTException

The command exports a role interface to a DataFile, which is saved to the Export Storage. The export is an asynchronous event. That is why it returns a process URI to enable the user to wait for the process to finish.

Parameters:

roleInterfaceUri - UESURI of the role interface to export

roleInterface - DTO that contains attributes of the export process

Returns:

UESURI of the export process

Throws:

UESRoleInterfaceRTException

Since:

UES8-04

getExportData

UESStreamHandler getExportData(UESURI roleInterfaceUri,
UESRoleInterfaceGetExportData roleInterface)
throws UESRoleInterfaceRTException

The command returns a data file generated by the export command. The file contains an exported role interface.

Parameters:

roleInterfaceUri - UESURI of the role interface we want to get the exported file from.

roleInterface - DTO that contains attributes concerning the file returned.

Returns:

Data file of an exported role interface.

Throws:

UESRoleInterfaceRTException

Since:

UES8-04

getRoleList

@UESCommand(stereotype=READ)

UESResultList<UESRoleInterfaceGetRoleListItem,UESRoleInterfaceGetRoleList> getRoleList(UESURI roleInterfaceUri,
UESRoleInterfaceGetRoleList criteria)
throws UESRoleInterfaceRTException

Returns list of roles, which the specified role interface is connected to.

Parameters:

roleInterfaceUri - UESURI of the role interface to retrieve the roles it is connected to.

criteria - Object containing paging criteria.

Returns:

Returns list of Objects representing roles, which the specified role interface is connected to. Contains instances of (RoleInterfaceGetRoleListItem).

Throws:

UESRoleInterfaceRTException

Since:

UES8-08