cz.ues.core.container

Interface UESMetaModel

@UESService
public interface UESMetaModel

Since:

UES7-10

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_METAMODEL URI of organizational unit business entity

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI locationUri, UESMetaModelCreate metaModel) Creates a new meta model.
void	delete(UESURI metaModelUri) This command deletes the specified meta model from the system.
UESURI	export(UESURI metaModelUri, UESMetaModelExport metaModel) The command exports a meta model to a DataFile, which is saved to the Export Storage.
UESMetaModelAttributes	getAttributes(UESURI metaModelUri) This command returns attributes representing the meta model specified by the metaModelUri parameter.
UESResultList<UESMetaModelEntryAttributes,UESMetaModelGetEntryList>	getEntryList(UESURI metaModelUri, UESMetaModelGetEntryList criteria) This command returns a list of entries (artifacts, meta artifacts, meta interfaces, containers, meta model dictionaries or shortcuts) enlisted in the specified meta model dictionary.
UESStreamHandler	getExportData(UESURI metaModelUri, UESMetaModelGetExportData metaModel) The command returns a data file generated by the export command.
UESURI	setAttributes(UESURI metaModelUri, UESMetaModelSetAttributes metaModel) Command for setting attributes of a meta model.

Field Detail

BETYPE_METAMODEL

static final BETYPE_METAMODEL

URI of organizational unit business entity

Since:

UES7-10

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
UESMetaModelCreate metaModel)
throws UESMetaModelRTException

Creates a new meta model. The command creates a new meta model in a specified location. At the very least meta artifact and name must be specified in UESMetaModelCreate DTO. Competent role for the meta model 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 UESMetaModelCreate DTO.

Parameters:

locationUri - UESURI of the folder/org. unit/meta model where meta model will be created.

metaModel - DTO containing attributes of the new meta model.

Returns:

UESURI of the new meta model.

Throws:

UESMetaModelRTException

Since:

UES7-10

getAttributes

@UESCommand(stereotype=READ)

UESMetaModelAttributes getAttributes(UESURI metaModelUri)
throws UESMetaModelRTException

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

Parameters:

metaModelUri - UESURI of a meta model whose attributes are returned

Returns:

DTO containing the meta model attributes

Throws:

UESMetaModelRTException

Since:

UES7-10

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI metaModelUri,
UESMetaModelSetAttributes metaModel)
throws UESMetaModelRTException

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

Parameters:

metaModelUri - UESURI of the meta model whose attributes are to be changed

metaModel - DTO containing new attributes the meta model

Returns:

UESURI of the meta model

Throws:

UESMetaModelRTException

Since:

UES7-10

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI metaModelUri)
throws UESMetaModelRTException

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

• the meta model is not empty.
• the meta model's workflow is not created
• a property contains a reference to this meta model
• a time sheet exists with a reference to this meta model

Parameters:

metaModelUri - UESURI of the meta model which is about to be deleted.

Throws:

UESMetaModelRTException

Since:

UES7-10

getEntryList

@UESCommand(stereotype=READ)

UESResultList<UESMetaModelEntryAttributes,UESMetaModelGetEntryList> getEntryList(UESURI metaModelUri,
UESMetaModelGetEntryList criteria)
throws UESMetaModelRTException

This command returns a list of entries (artifacts, meta artifacts, meta interfaces, containers, meta model dictionaries or shortcuts) enlisted in the specified meta model dictionary. Command does not return all entries, only a sublist. The list of returned entries could be filtered by the name, code or entityTypeUri of an entry. The list is sorted by the name (and codes in case are equal) of a entry by default, or it can be sorted arbitrarily by any of entry attributes usable for the filtering or these attributes combinations.

Parameters:

metaModelUri - UESURI of the meta model dictionary from where entries are listed.

criteria - DTO containing criteria. Available parameters are: name, code and entityTypeUri.

Returns:

List of DTO representing meta model dictionary entries.

Throws:

UESMetaModelRTException

Since:

UES7-10

See Also:

UESQuery Documentation.

export

UESURI export(UESURI metaModelUri,
UESMetaModelExport metaModel)
throws UESMetaModelRTException

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

metaModelUri - UESURI of the meta model to export

metaModel - DTO that contains attributes of the export process

Returns:

UESURI of the export process

Throws:

UESMetaModelRTException

Since:

UES8-04

getExportData

UESStreamHandler getExportData(UESURI metaModelUri,
UESMetaModelGetExportData metaModel)
throws UESMetaModelRTException

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

Parameters:

metaModelUri - UESURI of the meta model we want to get the exported file from.

metaModel - DTO that contains attributes concerning the file returned.

Returns:

Data file of an exported meta model.

Throws:

UESMetaModelRTException

Since:

UES8-04