cz.ues.core.role

Interface UESMetaGroup

@UESService
public interface UESMetaGroup

Since:

UES8-02

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addRoleInterface(UESURI metaGroupUri, UESMetaGroupAddRoleInterface roleInterface) This command creates new role interface connection to the specified meta group.
UESURI	copy(UESURI sourceMetaArtifactUri, UESMetaGroupCopy metaGroup) Copy a meta group.
UESURI	create(UESURI locationUri, UESMetaGroupCreate metaGroup) 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 metaGroupUri, UESMetaGroupExport metaGroup) The command exports a meta group to a DataFile, which is saved to the Export Storage.
UESMetaGroupAttributes	getAttributes(UESURI metaGroupUri) This command returns attributes representing the meta group specified by the metaGroupUri parameter.
UESStreamHandler	getExportData(UESURI metaGroupUri, UESMetaGroupGetExportData metaGroup) The command returns a data file generated by the export command.
UESResultList<UESMetaGroupGetRoleInterfaceListItem,UESMetaGroupGetRoleInterfaceList>	getRoleInterfaceList(UESURI metaGroupUri, UESMetaGroupGetRoleInterfaceList criteria) Returns list of the role interfaces that are added to the specified meta group.
void	removeRoleInterface(UESURI metaGroupUri, UESMetaGroupRemoveRoleInterface roleInterface) The command removes role interface connection from the specified meta group.
UESURI	setAttributes(UESURI metaGroupUri, UESMetaGroupSetAttributes metaGroup) Command for setting attributes of a meta group.

Field Detail

BETYPE_GROUP

static final BETYPE_GROUP

URI of meata group business entity.

Since:

UES8-02

Method Detail

getAttributes

UESMetaGroupAttributes getAttributes(UESURI metaGroupUri)
throws UESMetaGroupRTException

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

Parameters:

metaGroupUri - UESURI of a meta group whose attributes are returned

Returns:

DTO containing the meta group attributes

Throws:

UESMetaGroupRTException

Since:

UES8-02

setAttributes

UESURI setAttributes(UESURI metaGroupUri,
UESMetaGroupSetAttributes metaGroup)
throws UESMetaGroupRTException

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

Parameters:

metaGroupUri - UESURI of a meta group whose attributes shall be modified

metaGroup - DTO containing new attributes of the meta group

Returns:

UESURI of the meta group

Throws:

UESMetaGroupRTException

Since:

UES8-02

addRoleInterface

void addRoleInterface(UESURI metaGroupUri,
UESMetaGroupAddRoleInterface roleInterface)
throws UESMetaGroupRTException

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

Parameters:

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

roleInterface - DTO containing role interface that to be added

Throws:

UESMetaGroupRTException

Since:

UES8-02

removeRoleInterface

void removeRoleInterface(UESURI metaGroupUri,
UESMetaGroupRemoveRoleInterface roleInterface)
throws UESMetaGroupRTException

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

Parameters:

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

roleInterface - DTO containing role interface that to be removed

Throws:

UESMetaGroupRTException

Since:

UES8-02

getRoleInterfaceList

UESResultList<UESMetaGroupGetRoleInterfaceListItem,UESMetaGroupGetRoleInterfaceList> getRoleInterfaceList(UESURI metaGroupUri,
UESMetaGroupGetRoleInterfaceList criteria)
throws UESMetaGroupRTException

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

Parameters:

metaGroupUri - UES URI of the meta group 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 group

Throws:

UESMetaGroupRTException

Since:

UES8-02

copy

UESURI copy(UESURI sourceMetaArtifactUri,
UESMetaGroupCopy metaGroup)
throws UESMetaGroupRTException

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

Parameters:

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

metaGroup - DTO containing attributes of the new meta group copy.

Returns:

UESURI of the copied meta group.

Throws:

UESMetaGroupRTException

Since:

UES8-02

export

UESURI export(UESURI metaGroupUri,
UESMetaGroupExport metaGroup)
throws UESMetaGroupRTException

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

metaGroupUri - UESURI of the meta group to export

metaGroup - DTO that contains attributes of the export process

Returns:

UESURI of the export process

Throws:

UESMetaGroupRTException

Since:

UES8-02

getExportData

UESStreamHandler getExportData(UESURI metaGroupUri,
UESMetaGroupGetExportData metaGroup)
throws UESMetaGroupRTException

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

Parameters:

metaGroupUri - UESURI of the meta group we want to get the exported file from.

metaGroup - DTO that contains attributes concerning the file returned.

Returns:

Data file of an exported meta group.

Throws:

UESMetaGroupRTException

Since:

UES8-02

create

@Deprecated

UESURI create(UESURI locationUri,
UESMetaGroupCreate metaGroup)
throws UESMetaGroupRTException

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.

The command creates a Meta Group from an exported data file (or DTO) in the specified location.

Parameters:

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

metaGroup - DTO that contains attributes of the new Meta Group.

Returns:

UESURI of the new Meta Group.

Throws:

UESMetaGroupRTException

Since:

UES8-02