cz.ues.core.artifact

Interface UESArtifact

@UESService
public interface UESArtifact

Artifact is the representation of an complex information in the UES system. Everything in the UES system is information. A unit of information is an object. Some of the objects are more complicated and there are some extra characteristics which are useful to know. Some of these objects are needed for creating the UES structure and it is possible to aggregate other objects to them. These special objects are called artifacts. Artifacts enter into processes (activities) in a system or they are the results of processes. Artifacts have the same characteristics as objects plus some extra defined characteristics. Each piece of information in the system is represented as an Artifact or is a part of an artifact (it is an artifact's attribute or an aggregated object).

UES Artifact is service that provides operations over artifact.

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_ARTIFACT URI of artifact business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI locationUri, UESArtifactCreate artifact) Creates an artifact of class Artifact.
void	delete(UESURI artifactUri) This command deletes the specified artifact from the system.
UESURI	export(UESURI artifactUri, UESArtifactExport artifact) The command exports a artifact to a DataFile, which is saved to the Export Storage.
UESArtifactAttributes	getAttributes(UESURI artifactUri) This command gets the attributes of the artifact specified by artifact URI and returns its detail.
UESStreamHandler	getExportData(UESURI artifactUri, UESArtifactGetExportData artifact) The command returns a data file generated by the export command.
UESArtifactPresentationAttributes	getPresentationAttributes(UESURI artifactUri) Retrieves presentation settings of an artifact.
UESResultList<UESReferenceEntry,UESArtifactGetReferenceList>	getReferenceList(UESURI artifactUri, UESArtifactGetReferenceList criteria) This command returns a list of all references from the specified artifact and / or all references to the specified artifact from / to his territory (command does not return references from / to other territories).
void	move(UESURI artifactUri, UESArtifactMove newLocation) This command moves an artifact to the new location (folder, organizational unit, meta mode dictionary) in the same territory.
UESURI	setAttributes(UESURI artifactUri, UESArtifactSetAttributes artifact) Command for setting attributes of artifact.
void	setCompetentRole(UESURI artifactUri, UESArtifactSetCompetentRole newCompetency) This command sets a new competent role for an artifact (asynchronously).
UESURI	setPresentationAttributes(UESURI artifactUri, UESArtifactSetPresentationAttributes presentation) Configures presentation settings of an artifact.
void	setState(UESURI artifactUri, UESArtifactSetState state) This command sets a new state of the specified artifact.
void	setVisualPresentation(UESURI artifactUri, UESArtifactSetVisualPresentation presentation) Deprecated.

Field Detail

BETYPE_ARTIFACT

static final BETYPE_ARTIFACT

URI of artifact business entity.

Since:

UES6-06

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI locationUri,
UESArtifactCreate artifact)
throws UESArtifactRTException

Creates an artifact of class Artifact. Command creates new artifact in specified location. Meta artifact can be specified in UESArtifactCreate DTO, otherwise is used default meta artifact for territory. Competent role for artifact will be selected as the most suitable according to specified location and meta artifact (executive/authorized role with connected interface), or can be also specified in UESArtifactCreate DTO.

Parameters:

locationUri - URI of folder/org. unit/meta model where artifact will be created.

artifact - DTO containing attributes of a new artifact

Returns:

URI of created artifact.

Throws:

UESArtifactRTException

Since:

UES6-00

getAttributes

@UESCommand(stereotype=READ)

UESArtifactAttributes getAttributes(UESURI artifactUri)
throws UESArtifactRTException

This command gets the attributes of the artifact specified by artifact URI and returns its detail.

Parameters:

artifactUri - URI of required artifact

Returns:

DTO with attributes of artifact

Throws:

UESArtifactRTException

Since:

UES6-00

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI artifactUri,
UESArtifactSetAttributes artifact)
throws UESArtifactRTException

Command for setting attributes of artifact. Command can't modify references to object like storage, competent role and so on.

Parameters:

artifactUri - URI of required artifact

artifact - DTO containing attributes for updating the artifact

Returns:

URI of artifact

Throws:

UESArtifactRTException

Since:

UES6-00

setCompetentRole

@UESCommand(stereotype=UPDATE)

void setCompetentRole(UESURI artifactUri,
UESArtifactSetCompetentRole newCompetency)
throws UESArtifactRTException

This command sets a new competent role for an artifact (asynchronously).

Parameters:

artifactUri - UESURI of the artifact whose competency is about to be changed.

newCompetency - DTO containing attributes of the competency change

Throws:

UESArtifactRTException

Since:

UES6-00

setState

@UESCommand(stereotype=UPDATE)

void setState(UESURI artifactUri,
UESArtifactSetState state)
throws UESArtifactRTException

This command sets a new state of the specified artifact. The current state of an artifact can be retrieved by getAttributes command. Transition to the new state is driven by an activity on the artifact workflow. The activity itself sets the artifact state. There are three ways to specify this activity:

1. The easiest way is to specify the required artifact state from the enumeration UESArtifactStateType. In this scenario, an appropriate activity template is found (an activity transforming the artifact to the required state) and it is used the same way as in the third scenario. If there is no such an activity template, the command fails. If there are a few such activities, then the first one is used (activity templates are ordered by name and code for this purpose).

2. By the same pattern, it is possible to specify UESURI of the artifact state template we want to set. The advantage compared to the first scenario is that we can also set some specific custom states that are not included in the enumeration UESArtifactStateType without knowing the activity template that sets it.

3. The UESURI of the activity template can be also specified directly. This activity has to contain an action to change the artifact state on its exit activity state. The activity is created and it changes the artifact state. If the activity contains an action with an attached script then the script is run first asynchronously and the artifact state is set after the script finishes successfully (therefore the artifact state can be actually set later, e.g. two minutes after setState command finishes).

Parameters:

artifactUri - UESURI of the artifact which state is about to be changed.

state - DTO containing details of the state change.

Throws:

UESArtifactRTException

Since:

UES6-06

move

@UESCommand(stereotype=UPDATE)

void move(UESURI artifactUri,
UESArtifactMove newLocation)
throws UESArtifactRTException

This command moves an artifact to the new location (folder, organizational unit, meta mode dictionary) in the same territory. It optionally leaves a shortcut at the original location.

Parameters:

artifactUri - UESURI of the artifact to be moved

newLocation - DTO containing details of the moving

Throws:

UESArtifactRTException

Since:

UES6-06

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI artifactUri)
throws UESArtifactRTException

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

• the artifact's workflow is not created
• a property contains a reference to this artifact
• a time sheet exists with a reference to this artifact

Parameters:

artifactUri - UESURI of the artifact which is about to be deleted.

Throws:

UESArtifactRTException

Since:

UES6-10

getReferenceList

@UESCommand(stereotype=READ)

UESResultList<UESReferenceEntry,UESArtifactGetReferenceList> getReferenceList(UESURI artifactUri,
UESArtifactGetReferenceList criteria)
throws UESArtifactRTException

This command returns a list of all references from the specified artifact and / or all references to the specified artifact from / to his territory (command does not return references from / to other territories). The command does not return all references, only a sublist. The list of returned references can be filtered by the name and code of the artefact, by the meta artifact uri of the artifact, by the type of the reference, direction and the reference count. The list is sorted by the name, code and type by default, or it can be sorted arbitrarily by any of reference attributes usable for the filtering or these attributes combinations.

Parameters:

artifactUri - UESURI of the artifact to which and/or from which the references are listed.

criteria - DTO containing criteria for listing references. Available parameters are: name, code, entityTypeUri, type : UESReferenceType, direction : UESReferenceDirection and count.

Returns:

List of DTO representing references to and/or from the artifactUri.

Throws:

UESArtifactRTException

Since:

UES7-01

See Also:

UESQuery Documentation.

setVisualPresentation

@UESCommand(stereotype=UPDATE) @Deprecated

void setVisualPresentation(UESURI artifactUri,
UESArtifactSetVisualPresentation presentation)
throws UESArtifactRTException

Deprecated.

This command sets an artifact presentation settings. The current presentation settings of an artifact can be retrieved by getAttributes command. Artifact presentation settings consists of width. Changing the width of the artifact changes the width of the content part of the artifact. Artifact width is used as default width for all artifact sheets and in visual use cases over artifact and its aggregated objects.

Parameters:

artifactUri - UESURI of the artifact which layout is about to be changed.

presentation - DTO containing presentation settings.

Throws:

UESArtifactRTException

Since:

UES7-01

setPresentationAttributes

@UESCommand(stereotype=UPDATE)

UESURI setPresentationAttributes(UESURI artifactUri,
UESArtifactSetPresentationAttributes presentation)
throws UESArtifactRTException

Configures presentation settings of an artifact. 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 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.

Parameters:

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

presentation - DTO containing presentation settings.

Throws:

UESArtifactRTException

Since:

UES8-03

getPresentationAttributes

@UESCommand(stereotype=READ)

UESArtifactPresentationAttributes getPresentationAttributes(UESURI artifactUri)
throws UESArtifactRTException

Retrieves presentation settings of an artifact. 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 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.

Parameters:

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

Throws:

UESArtifactRTException

Since:

UES8-03

export

UESURI export(UESURI artifactUri,
UESArtifactExport artifact)
throws UESArtifactRTException

The command exports a 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 artifact to export

artifact - DTO that contains attributes of the export process

Returns:

UESURI of the export process

Throws:

UESArtifactRTException

Since:

UES8-03

getExportData

UESStreamHandler getExportData(UESURI artifactUri,
UESArtifactGetExportData artifact)
throws UESArtifactRTException

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

Parameters:

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

artifact - DTO that contains attributes concerning the file returned.

Returns:

Data file of an exported artifact.

Throws:

UESArtifactRTException

Since:

UES8-04