cz.ues.core.artifact

Interface UESMetaArtifact

@UESService
public interface UESMetaArtifact

Since:

UES7-10

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	copy(UESURI sourceMetaArtifactUri, UESMetaArtifactCopy metaArtifact) Copy a meta artifact.
UESURI	create(UESURI locationUri, UESMetaArtifactCreate metaArtifact) 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 metaArtifactUri, UESMetaArtifactExport metaArtifact) The command exports a meta artifact to a DataFile, which is saved to the Export Storage.
UESMetaArtifactAttributes	getAttributes(UESURI metaArtifactUri) This command returns attributes representing the meta artifact specified by the metaArtifactUri parameter.
UESMetaArtifactDefaultPresentationAttributes	getDefaultPresentationAttributes(UESURI metaArtifactUri) Retrieves an artifact presentation template.
UESStreamHandler	getExportData(UESURI metaArtifactUri, UESMetaArtifactGetExportData metaArtifact) The command returns a data file generated by the export command.
UESMetaArtifactPresentationAttributes	getPresentationAttributes(UESURI metaArtifactUri) Retrieves meta artifact presentation settings.
UESURI	setAttributes(UESURI metaArtifactUri, UESMetaArtifactSetAttributes metaArtifact) Command for setting attributes of a meta artifact.
UESURI	setDefaultPresentationAttributes(UESURI metaArtifactUri, UESMetaArtifactSetDefaultPresentationAttributes presentation) Configures an artifact presentation template.
UESURI	setPresentationAttributes(UESURI metaArtifactUri, UESMetaArtifactSetPresentationAttributes presentation) Configures meta artifact presentation settings.

Method Detail

getAttributes

@UESCommand(stereotype=READ)

UESMetaArtifactAttributes getAttributes(UESURI metaArtifactUri)
throws UESMetaArtifactRTException

This command returns attributes representing the meta artifact specified by the metaArtifactUri parameter. Only basic meta artifact types attributes can be returned by this command (no meta role, meta group, etc.). The command does not change the state of the meta artifact in the system.

Parameters:

metaArtifactUri - UESURI of a meta artifact whose attributes are returned

Returns:

DTO containing the meta artifact attributes

Throws:

UESMetaArtifactRTException

Since:

UES7-10

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI metaArtifactUri,
UESMetaArtifactSetAttributes metaArtifact)
throws UESMetaArtifactRTException

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

Parameters:

metaArtifactUri - UESURI of a meta artifact whose attributes are returned

metaArtifact - DTO containing new attributes of the meta artifact

Returns:

UESURI of the meta artifact

Throws:

UESMetaArtifactRTException

Since:

UES7-10

copy

@UESCommand(stereotype=CREATE)

UESURI copy(UESURI sourceMetaArtifactUri,
UESMetaArtifactCopy metaArtifact)
throws UESMetaArtifactRTException

Copy a meta artifact. The command creates a new meta artifact according to specified source meta artifact in a specified location in the same territory as source meta artifact. At the very least location and name must be specified in UESMetaArtifactCopy DTO. Only basic meta artifact types can be copied by this command (no meta role, meta group, etc.). Competent role for the new meta artifact copy 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 UESMetaArtifactCopy DTO.

Parameters:

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

metaArtifact - DTO containing attributes of the new meta artifact copy.

Returns:

UESURI of the copied meta artifact.

Throws:

UESMetaArtifactRTException

Since:

UES7-10

export

UESURI export(UESURI metaArtifactUri,
UESMetaArtifactExport metaArtifact)
throws UESMetaArtifactRTException

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

artifactUri - UESURI of the meta artifact to export

metaArtifact - DTO that contains attributes of the export process

Returns:

UESURI of the export process

Throws:

UESMetaArtifactRTException

Since:

UES7-10

create

@Deprecated @UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
UESMetaArtifactCreate metaArtifact)
throws UESMetaArtifactRTException

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 artifact from an exported data file (or DTO) 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.

Parameters:

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

metaArtifact - DTO that contains attributes of the new Meta Artifact.

Returns:

UESURI of the new Meta Artifact.

Throws:

UESMetaArtifactRTException

Since:

UES7-10

getExportData

UESStreamHandler getExportData(UESURI metaArtifactUri,
UESMetaArtifactGetExportData metaArtifact)
throws UESMetaArtifactRTException

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

Parameters:

metaArtifactUri - UESURI of the meta artifact we want to get the exported file from.

metaArtifact - DTO that contains attributes concerning the file returned.

Returns:

Data file of an exported meta artifact.

Throws:

UESMetaArtifactRTException

Since:

UES7-10

setDefaultPresentationAttributes

@UESCommand(stereotype=UPDATE)

UESURI setDefaultPresentationAttributes(UESURI metaArtifactUri,
UESMetaArtifactSetDefaultPresentationAttributes presentation)
throws UESMetaArtifactRTException

Configures an artifact presentation template. Artifact presentation template consist of width, header visibility, toolbar visibility, and context menu visibility. All of these attributes control default presentation of an artifact created with this meta artifact. When viewing an artifact, presentation settings are looked up in the following order: User settings, artifact presentation settings, meta artifact template presentation settings, and layout artifact, if it is configured, or default system settings otherwise. Attribute lockSettings on the DTO can make user settings and artifact presentation settings to be ignored.

Parameters:

metaArtifactUri - UESURI of the meta artifact whose presentation template is to be changed.

presentation - DTO containing presentation template values.

Throws:

UESMetaArtifactRTException

Since:

UES8-03

getDefaultPresentationAttributes

@UESCommand(stereotype=READ)

UESMetaArtifactDefaultPresentationAttributes getDefaultPresentationAttributes(UESURI metaArtifactUri)
throws UESMetaArtifactRTException

Retrieves an artifact presentation template. Artifact presentation template consists of width, header visibility, toolbar visibility, and context menu visibility. All of these attributes control default presentation of an artifact created with this meta artifact. When viewing an artifact, presentation settings are looked up in the following order: User settings, artifact presentation settings, meta artifact template presentation settings, and layout artifact, if it is configured, or default system settings otherwise. Attribute lockSettings on the DTO can make user settings and artifact presentation settings to be ignored.

Parameters:

metaArtifactUri - UESURI of the meta artifact whose presentation template is to be retrieved.

Throws:

UESMetaArtifactRTException

Since:

UES8-03

setPresentationAttributes

@UESCommand(stereotype=UPDATE)

UESURI setPresentationAttributes(UESURI metaArtifactUri,
UESMetaArtifactSetPresentationAttributes presentation)
throws UESMetaArtifactRTException

Configures meta artifact presentation settings. Meta artifact presentation settings consist of width, layout artifact UESURI, header visibility, toolbar visibility, and context menu visibility. All of these attributes control presentation of the meta artifact. When viewing a meta artifact, presentation settings are looked up in the following order: User settings, meta artifact presentation settings, meta artifact template presentation settings, and layout artifact, if it is configured, or default system settings otherwise.

Parameters:

metaArtifactUri - UESURI of the meta artifact whose presentation settings are to be changed.

presentation - DTO containing presentation settings.

Throws:

UESMetaArtifactRTException

Since:

UES8-03

getPresentationAttributes

@UESCommand(stereotype=READ)

UESMetaArtifactPresentationAttributes getPresentationAttributes(UESURI metaArtifactUri)
throws UESMetaArtifactRTException

Retrieves meta artifact presentation settings. Meta artifact presentation settings consist of width, layout artifact UESURI, header visibility, toolbar visibility, and context menu visibility. All of these attributes control presentation of the meta artifact. When viewing a meta artifact, presentation settings are looked up in the following order: User settings, meta artifact presentation settings, meta artifact template presentation settings, and layout artifact, if it is configured, or default system settings otherwise.

Parameters:

metaArtifactUri - UESURI of the meta artifact whose presentation settings are to be retrieved.

Throws:

UESMetaArtifactRTException

Since:

UES8-03