cz.ues.core.workflow

Interface UESArtifactStateTemplate

@UESService
public interface UESArtifactStateTemplate

UESArtifactStateTemplate is a service that provides operations related to artifact state templates.

Since:

UES8-07

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_ARTIFACT_STATE_TEMPLATE URI of UESArtifactStateTemplate business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI metaArtifactUri, UESArtifactStateTemplateCreate artifactStateTemplate) Creates a new artifact state template on the specified meta artifact.
void	delete(UESURI artifactStateTemplateUri) Deletes the specified artifact state template from the system.
UESResultList<UESArtifactStateTemplateAttributes,UESArtifactStateTemplateGetArtifactStateTemplateList>	getArtifactStateTemplateList(UESURI metaArtifactUri, UESArtifactStateTemplateGetArtifactStateTemplateList criteria) Returns a list of artifact state templates on the specified meta artifact.
UESArtifactStateTemplateAttributes	getAttributes(UESURI artifactStateTemplateUri) Returns attributes of the specified artifact state template.
UESURI	setAttributes(UESURI artifactStateTemplateUri, UESArtifactStateTemplateSetAttributes artifactStateTemplate) Sets attributes of an artifact state template.

Field Detail

BETYPE_ARTIFACT_STATE_TEMPLATE

static final BETYPE_ARTIFACT_STATE_TEMPLATE

URI of UESArtifactStateTemplate business entity.

Method Detail

create

@UESCommand(stereotype=CREATE)

UESURI create(UESURI metaArtifactUri,
UESArtifactStateTemplateCreate artifactStateTemplate)
throws UESArtifactStateTemplateRTException

Creates a new artifact state template on the specified meta artifact. At least, its future name and type have to be specified in this command.

Parameters:

metaArtifactUri - UESURI of the meta artifact the new artifact state template is to be created on.

artifactStateTemplate - Object containing attributes of the new artifact state template.

Returns:

UESURI of the new artifact state template.

Throws:

UESArtifactStateTemplateRTException

Since:

UES8-07

getAttributes

@UESCommand(stereotype=READ)

UESArtifactStateTemplateAttributes getAttributes(UESURI artifactStateTemplateUri)
throws UESArtifactStateTemplateRTException

Returns attributes of the specified artifact state template.

Parameters:

artifactStateTemplateUri - UESURI of the artifact state template whose attributes are to be returned.

Returns:

Object with attributes of the artifact state template.

Throws:

UESArtifactStateTemplateRTException

Since:

UES8-07

setAttributes

@UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI artifactStateTemplateUri,
UESArtifactStateTemplateSetAttributes artifactStateTemplate)
throws UESArtifactStateTemplateRTException

Sets attributes of an artifact state template. This command cannot modify the type and activity template.

Parameters:

artifactStateTemplateUri - UESURI of the artifact state template whose attributes are to be modified.

artifactStateTemplate - Object containing new attributes of the artifact state template.

Returns:

UESURI of the modified artifact state template.

Throws:

UESArtifactStateTemplateRTException

Since:

UES8-07

delete

@UESCommand(stereotype=DELETE)

void delete(UESURI artifactStateTemplateUri)
throws UESArtifactStateTemplateRTException

Deletes the specified artifact state template from the system. It cannot be deleted in case there is an action that sets a state based on this template. Also, a system state and any state set as entry state cannot be deleted.

Parameters:

artifactStateTemplateUri - UESURI of the artifact state template which is to be deleted.

Throws:

UESArtifactStateTemplateRTException

Since:

UES8-07

getArtifactStateTemplateList

@UESCommand(stereotype=READ)

UESResultList<UESArtifactStateTemplateAttributes,UESArtifactStateTemplateGetArtifactStateTemplateList> getArtifactStateTemplateList(UESURI metaArtifactUri,
UESArtifactStateTemplateGetArtifactStateTemplateList criteria)
throws UESArtifactStateTemplateRTException

Returns a list of artifact state templates on the specified meta artifact. The command does not return all artifact state templates, only a sublist. The list of returned artifact state templates can be filtered by the name, code, type, entryState, order and activityTemplateExists. The list is sorted by the attribute order (and by name in case orders are equal) of an artifact state template by default, or it can be sorted arbitrarily by any of artifact state template attributes usable for filtering or by combinations of such attributes. See the UES query documentation for more information.

Parameters:

metaArtifactUri - UESURI of the meta artifact whose artifact state templates are to be listed.

criteria - Object containing attributes of the artifact state templates that are to be listed.

Returns:

List of Objects representing artifact state templates (the same objects as in the command getAttributes).

Throws:

UESArtifactStateTemplateRTException

Since:

UES8-07

See Also:

UESQuery Documentation.