cz.ues.core.role

Interface UESMetaRole

@UESService
public interface UESMetaRole

Since:

UES8-02

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BEMETAROLE_CODE Code of meta role business entity.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRoleInterface(UESURI metaRoleUri, UESMetaRoleAddRoleInterface roleInterface) This command creates new role interface connection to the specified meta role.
UESURI	copy(UESURI sourceMetaArtifactUri, UESMetaRoleCopy metaRole) Copy a meta role.
UESURI	create(UESURI locationUri, UESMetaRoleCreate metaRole) Deprecated. This command is backward incompatible (older versions of the meta artifact's XML can be unsupported). New commands will be prepared for creating object templates.
UESURI	export(UESURI metaRoleUri, UESMetaRoleExport metaRole) The command exports a meta role to a DataFile, which is saved to the Export Storage.
UESMetaRoleAttributes	getAttributes(UESURI metaRoleUri) This command returns attributes representing the meta role specified by the metaRoleUri parameter.
UESStreamHandler	getExportData(UESURI metaRoleUri, UESMetaRoleGetExportData metaRole) The command returns a data file generated by the export command.
UESResultList<UESMetaRoleGetRoleInterfaceListItem,UESMetaRoleGetRoleInterfaceList>	getRoleInterfaceList(UESURI metaRoleUri, UESMetaRoleGetRoleInterfaceList criteria) Returns list of the role interfaces that are added to the specified meta role.
void	removeRoleInterface(UESURI metaRoleUri, UESMetaRoleRemoveRoleInterface roleInterface) The command removes role interface connection from the specified meta role.
UESURI	setAttributes(UESURI metaRoleUri, UESMetaRoleSetAttributes metaRole) Command for setting attributes of a meta role.

Field Detail

BEMETAROLE_CODE

static final BEMETAROLE_CODE

Code of meta role business entity.

See Also:

Constant Field Values

Method Detail

getAttributes

UESMetaRoleAttributes getAttributes(UESURI metaRoleUri)
throws UESMetaRoleRTException

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

Parameters:

metaRoleUri - UESURI of a meta role whose attributes are returned

Returns:

DTO containing the meta role attributes

Throws:

UESMetaRoleRTException

Since:

UES8-02

setAttributes

UESURI setAttributes(UESURI metaRoleUri,
UESMetaRoleSetAttributes metaRole)
throws UESMetaRoleRTException

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

Parameters:

metaRoleUri - UESURI of the meta role whose attributes are to be set

metaRole - DTO containing new attributes of the meta role

Returns:

UESURI of the meta role

Throws:

UESMetaRoleRTException

Since:

UES8-02

copy

UESURI copy(UESURI sourceMetaArtifactUri,
UESMetaRoleCopy metaRole)
throws UESMetaRoleRTException

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

Parameters:

sourceMetaArtifactUri - UESURI of the meta role which will be copied.

metaRole - DTO containing attributes of the new meta role copy.

Returns:

UESURI of the copied meta role

Throws:

UESMetaRoleRTException

Since:

UES8-02

addRoleInterface

void addRoleInterface(UESURI metaRoleUri,
UESMetaRoleAddRoleInterface roleInterface)
throws UESMetaRoleRTException

This command creates new role interface connection to the specified meta role. The role interface has to be in an active state and must not be already added. The role interface can be added to meta role only provided that role interface is located in the same, child or parent meta model as meta role.

Parameters:

metaRoleUri - UES URI of the meta role where the role interface will be added

roleInterface - DTO containing role interface that to be added

Throws:

UESMetaRoleRTException

Since:

UES8-02

getRoleInterfaceList

UESResultList<UESMetaRoleGetRoleInterfaceListItem,UESMetaRoleGetRoleInterfaceList> getRoleInterfaceList(UESURI metaRoleUri,
UESMetaRoleGetRoleInterfaceList criteria)
throws UESMetaRoleRTException

Returns list of the role interfaces that are added to the specified meta 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 codes in case are equal) of an interface by default. See Also: UES Query Documentation

Parameters:

metaRoleUri - UES URI of the meta role for which the added role interfaces are to be listed

criteria - DTO containing criteria for listing added role interfaces

Returns:

List of DTO representing role interfaces which are added to the specified meta role

Throws:

UESMetaRoleRTException

Since:

UES8-02

removeRoleInterface

void removeRoleInterface(UESURI metaRoleUri,
UESMetaRoleRemoveRoleInterface roleInterface)
throws UESMetaRoleRTException

The command removes role interface connection from the specified meta role. Only added interfaces can be removed from meta role.

Parameters:

metaRoleUri - UES URI of the meta role where the role interface will be removed

roleInterface - DTO containing role interface that to be removed

Throws:

UESMetaRoleRTException

Since:

UES8-02

export

UESURI export(UESURI metaRoleUri,
UESMetaRoleExport metaRole)
throws UESMetaRoleRTException

The command exports a meta role 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:

metaRoleUri - UESURI of the meta role to export

metaRole - DTO that contains attributes of the export process

Returns:

UESURI of the export process

Throws:

UESMetaRoleRTException

Since:

UES8-02

getExportData

UESStreamHandler getExportData(UESURI metaRoleUri,
UESMetaRoleGetExportData metaRole)
throws UESMetaRoleRTException

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

Parameters:

metaRoleUri - UESURI of the meta role we want to get the exported file from.

metaRole - DTO that contains attributes concerning the file returned.

Returns:

Data file of an exported meta role.

Throws:

UESMetaRoleRTException

Since:

UES8-02

create

@Deprecated

UESURI create(UESURI locationUri,
UESMetaRoleCreate metaRole)
throws UESMetaRoleRTException

Deprecated. This command is backward incompatible (older versions of the meta artifact's XML can be unsupported). New commands will be prepared for creating object templates.

Creates a meta role from an exported XML file in the specified location. Source meta role must be derived (at least indirectly) from a meta artifact which is a part of UU.OS uuApp. Creation of meta role is divided into synchronous and asynchronous part. During the synchronous part, the meta role is created. During the asynchronous part, the template objects are created. If the asynchronous process fails and the Problem state is set on meta role, it is possible to solve the problem (e.g. add reference_map) and run the command again.

Parameters:

locationUri - UESURI of the Meta Model Dictionary where new Meta Role is created.

metaRole - DTO that contains attributes of the new Meta Role.

Returns:

UESURI of the new Meta Role.

Throws:

UESMetaRoleRTException

Since:

UES8-02