cz.ues.core.role

Interface UESMetaAccessRole

@UESService
public interface UESMetaAccessRole

Since:

UES8-02

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addRoleInterface(UESURI metaAccessRoleUri, UESMetaAccessRoleAddRoleInterface roleInterface) This command creates new role interface connection to the specified meta access role.
UESURI	copy(UESURI sourceMetaArtifactUri, UESMetaAccessRoleCopy metaAccessRole) Copy a meta access role.
UESURI	create(UESURI locationUri, UESMetaAccessRoleCreate metaAccessRole) 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 metaAccessRoleUri, UESMetaAccessRoleExport metaAccessRole) The command exports a meta access role to a DataFile, which is saved to the Export Storage.
UESMetaAccessRoleAttributes	getAttributes(UESURI metaAccessRoleUri) This command returns attributes representing the meta access role role specified by the metaAccessRoleRoleUri parameter.
UESStreamHandler	getExportData(UESURI metaAccessRoleUri, UESMetaAccessRoleGetExportData metaAccessRole) The command returns a data file generated by the export command.
UESResultList<UESMetaAccessRoleGetRoleInterfaceListItem,UESMetaAccessRoleGetRoleInterfaceList>	getRoleInterfaceList(UESURI metaAccessRoleUri, UESMetaAccessRoleGetRoleInterfaceList criteria) Returns list of the role interfaces that are added to the specified meta access role.
void	removeRoleInterface(UESURI metaAccessRoleUri, UESMetaAccessRoleRemoveRoleInterface roleInterface) The command removes role interface connection from the specified meta access role.
UESURI	setAttributes(UESURI metaAccessRoleUri, UESMetaAccessRoleSetAttributes metaAccessRole) Command for setting attributes of a meta access role.

Field Detail

BETYPE_ACCESSROLE

static final BETYPE_ACCESSROLE

URI of meata access role business entity.

Since:

UES8-02

Method Detail

getAttributes

UESMetaAccessRoleAttributes getAttributes(UESURI metaAccessRoleUri)
throws UESMetaAccessRoleRTException

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

Parameters:

metaAccessRoleUri - UESURI of a meta access role whose attributes are returned

Returns:

DTO containing the meta access role attributes

Throws:

UESMetaAccessRoleRTException

Since:

UES8-02

setAttributes

UESURI setAttributes(UESURI metaAccessRoleUri,
UESMetaAccessRoleSetAttributes metaAccessRole)
throws UESMetaAccessRoleRTException

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

Parameters:

metaAccessRoleUri - UESURI of a meta access role whose attributes shall be modified

metaAccessRole - DTO containing new attributes of the meta access role

Returns:

UESURI of the meta access role

Throws:

UESMetaAccessRoleRTException

Since:

UES8-02

addRoleInterface

void addRoleInterface(UESURI metaAccessRoleUri,
UESMetaAccessRoleAddRoleInterface roleInterface)
throws UESMetaAccessRoleRTException

This command creates new role interface connection to the specified meta access 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 access role only provided that role interface is located in the same, child or parent meta model as meta access role.

Parameters:

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

roleInterface - DTO containing role interface that to be added

Throws:

UESMetaAccessRoleRTException

Since:

UES8-02

removeRoleInterface

void removeRoleInterface(UESURI metaAccessRoleUri,
UESMetaAccessRoleRemoveRoleInterface roleInterface)
throws UESMetaAccessRoleRTException

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

Parameters:

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

roleInterface - DTO containing role interface that to be removed

Throws:

UESMetaAccessRoleRTException

Since:

UES8-02

getRoleInterfaceList

UESResultList<UESMetaAccessRoleGetRoleInterfaceListItem,UESMetaAccessRoleGetRoleInterfaceList> getRoleInterfaceList(UESURI metaAccessRoleUri,
UESMetaAccessRoleGetRoleInterfaceList criteria)
throws UESMetaAccessRoleRTException

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

Parameters:

metaAccessRoleUri - UES URI of the meta access 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 access role

Throws:

UESMetaAccessRoleRTException

Since:

UES8-02

copy

UESURI copy(UESURI sourceMetaArtifactUri,
UESMetaAccessRoleCopy metaAccessRole)
throws UESMetaAccessRoleRTException

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

Parameters:

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

metaAccessRole - DTO containing attributes of the new meta access role copy.

Returns:

UESURI of the copied meta access role.

Throws:

UESMetaAccessRoleRTException

Since:

UES8-02

export

UESURI export(UESURI metaAccessRoleUri,
UESMetaAccessRoleExport metaAccessRole)
throws UESMetaAccessRoleRTException

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

metaAccessRoleUri - UESURI of the meta access role to export

metaAccessRole - DTO that contains attributes of the export process

Returns:

UESURI of the export process

Throws:

UESMetaAccessRoleRTException

Since:

UES8-02

getExportData

UESStreamHandler getExportData(UESURI metaAccessRoleUri,
UESMetaAccessRoleGetExportData metaAccessRole)
throws UESMetaAccessRoleRTException

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

Parameters:

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

metaAccessRole - DTO that contains attributes concerning the file returned.

Returns:

Data file of an exported meta access role.

Throws:

UESMetaAccessRoleRTException

Since:

UES8-02

create

@Deprecated

UESURI create(UESURI locationUri,
UESMetaAccessRoleCreate metaAccessRole)
throws UESMetaAccessRoleRTException

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 access role from an exported XML file in the specified location. Source meta artifact must be derived (at least indirectly) from a meta artifact which is a part of UU.OS uuApp. Creation of meta artifact is divided into synchronous and asynchronous part. During the synchronous part, the meta artifact is created. During the asynchronous part, the template objects are created. If the asynchronous process fails and the Problem state is set on meta artifact, 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 Access Role is created.

metaAccessRole - DTO that contains attributes of the new Meta Access Role.

Returns:

Data file of an exported Meta Access Role.

Throws:

UESURI - of the new Meta Access Role.

UESMetaAccessRoleRTException

Since:

UES8-02