cz.ues.core.workflow

Interface UESActivityTemplate

@UESService
public interface UESActivityTemplate

UESActivityTemplate is a service that provides operations related to activity templates.

Since:

UES8-07

Field Summary

Fields

Modifier and Type	Field and Description
static UESURI	BETYPE_ACTIVITY_TEMPLATE URI of UESActivityTemplate business entity.

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	create(UESURI parentNodeUri, UESActivityTemplateCreate activityTemplate) Creates a new activity template either on the specified meta artifact or on the specified activity template (in the case of creating a new template for subactivities).
void	delete(UESURI activityTemplateUri) Deletes the activity template.
UESResultList<UESActivityTemplateAttributes,UESActivityTemplateGetActivityTemplateList>	getActivityTemplateList(UESURI metaArtifactUri, UESActivityTemplateGetActivityTemplateList criteria) Returns a list of activity templates of the specified meta artifact according to the entered criteria.
UESActivityTemplateAttributes	getAttributes(UESURI activityTemplateUri) Returns attributes of the specified activity template.
UESURI	setAttributes(UESURI activityTemplateUri, UESActivityTemplateSetAttributes activityTemplate) Sets basic attributes of the specified activity template.

Field Detail

BETYPE_ACTIVITY_TEMPLATE

static final BETYPE_ACTIVITY_TEMPLATE

URI of UESActivityTemplate business entity.

Method Detail

create

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=CREATE)

UESURI create(UESURI parentNodeUri,
UESActivityTemplateCreate activityTemplate)
throws UESActivityTemplateRTException

Creates a new activity template either on the specified meta artifact or on the specified activity template (in the case of creating a new template for subactivities). At least, its future name and type have to be specified in this command.

Parameters:

parentNodeUri - UESURI of the meta artifact (or activity template) the new activity template should be created on.

activityTemplate - Object containing attributes of the new activity template.

Returns:

UESURI of the new activity template

Throws:

UESActivityTemplateRTException

Since:

UES8-07

getAttributes

@UESCommand(stereotype=READ)

UESActivityTemplateAttributes getAttributes(UESURI activityTemplateUri)
throws UESActivityTemplateRTException

Returns attributes of the specified activity template.

Parameters:

activityTemplateUri - UESURI of an activity template whose attributes are to be returned.

Returns:

Object with attributes of the activity template.

Throws:

UESActivityTemplateRTException

Since:

UES8-07

setAttributes

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=UPDATE)

UESURI setAttributes(UESURI activityTemplateUri,
UESActivityTemplateSetAttributes activityTemplate)
throws UESActivityTemplateRTException

Sets basic attributes of the specified activity template. This command cannot modify the type.

Parameters:

activityTemplateUri - UESURI of the activity template whose attributes are to be modified.

activityTemplate - Object containing new attributes of the activity template.

Returns:

UESURI of the modified activity template.

Throws:

UESActivityTemplateRTException

Since:

UES8-07

delete

@UESAudit(propagation=SKIP, useCaseType=COMMAND) @UESCommand(stereotype=DELETE)

void delete(UESURI activityTemplateUri)
throws UESActivityTemplateRTException

Deletes the activity template. It cannot be deleted in case there is an action or condition that contains this template or if the template has already been used for creating another template. Also, it is not possible to delete generic templates.

Parameters:

activityTemplateUri - UESURI of the activity template which is to be deleted.

Throws:

UESActivityTemplateRTException

Since:

UES8-07

getActivityTemplateList

@UESCommand(stereotype=READ)

UESResultList<UESActivityTemplateAttributes,UESActivityTemplateGetActivityTemplateList> getActivityTemplateList(UESURI metaArtifactUri,
UESActivityTemplateGetActivityTemplateList criteria)
throws UESActivityTemplateRTException

Returns a list of activity templates of the specified meta artifact according to the entered criteria. Criteria are defined using query. The list of returned activity state templates can be filtered and sorted by the name, code, type, blockTimeInCalendar, allowExecutiveRoleChange and allowSubactivities (or by combinations of those attributes). The list is sorted by the attribute name (and by code in case names are equal) of activity templates by default. See the UES query documentation for more information.

Parameters:

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

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

Returns:

List of Objects representing activity templates including templates for subactivities (the same objects as in the command getAttributes).

Throws:

UESActivityTemplateRTException

Since:

UES8-07

See Also:

UESQuery Documentation.