cz.ues.core.workflow.dto

Class UESActivityStateTemplateSetAttributes

java.lang.Object

cz.ues.core.workflow.dto.UESActivityStateTemplateSetAttributes

@DTO
public class UESActivityStateTemplateSetAttributes
extends java.lang.Object

DTO for command UESActivityStateTemplate.setAttributes(UESURI, UESActivityStateTemplateSetAttributes).

Since:

UES8-07

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	code The new code of the activity state template.
private java.lang.String	description The new description of the activity state template.
private UESActivityStateVisibility[]	digitalWorkspaceVisibility Set of roles which will get a digital workspace record in their digital workspace in the case when an activity is set to the state which is created according to this activity state template.
private java.lang.Boolean	entryState After an activity is created according to an activity template, it will be set into the state marked as the entry state.
private java.lang.Boolean	exitState There is always just one activity state template marked as the exit state on every activity template.
private UESURI	iconUri UESURI of the new activity state template's icon.
private java.lang.String	name The new name of the activity state template.
private java.lang.Integer	order Order of the activity state template.
private UESActivityStateParticipant[]	participants Set of participants who can set activity state according to this template.
private UESActivityStateSubtype	subtype The new subtype of the activity state template.

Constructor Summary

Constructors

Constructor and Description
UESActivityStateTemplateSetAttributes() Empty constructor.
UESActivityStateTemplateSetAttributes(java.lang.String name, java.lang.String code, java.lang.String description, UESActivityStateSubtype subtype, java.lang.Boolean entryState, java.lang.Boolean exitState, UESURI iconUri, java.lang.Integer order, UESActivityStateParticipant[] participants, UESActivityStateVisibility[] digitalWorkspaceVisibility) Full constructor.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

private name

The new name of the activity state template. If it is not specified, the name is not modified.

code

private code

The new code of the activity state template. If it is not specified, the code is not modified. If blank string is set, the code is generated automatically using the system sequence. The code must be unique in the scope of the given meta artifact, otherwise the setAttributes command fails.

description

private description

The new description of the activity state template. If it is not specified, the description is not modified.

subtype

private subtype

The new subtype of the activity state template. If it is not specified, the subtype is not modified.

entryState

private entryState

After an activity is created according to an activity template, it will be set into the state marked as the entry state. There is always just one activity state template marked as the entry state on every activity template. By setting true, the new activity state template will become the entry state instead of the one previously specified. If the user tries to set false to an existing entry state, the setAttributes command fails. If it is not specified, the parameter is not modified.

exitState

private exitState

There is always just one activity state template marked as the exit state on every activity template. By setting true, the new activity state template will become the exit state instead of the one previously specified. If the user tries to set false to an existing exit state, the setAttributes command fails. If it is not specified, the parameter is not modified.

iconUri

private iconUri

UESURI of the new activity state template's icon. If it is not specified, the icon is not modified. If null UESURI ("ues:[-1]:[-1]:") is set, the activity state template's icon is replaced by a default icon derived from the type.

Allowed format URI of icon: ues:#{system}:#{ues_v5.core_v1.codetable_v1.base_v1.CodeTable_Icons}:#{CODE_OF_ICON}

For example: ues:#{system}:#{ues_v5.core_v1.codetable_v1.base_v1.CodeTable_Icons}:#{S00_C01}

order

private order

Order of the activity state template. All activity state templates are suggested to the user in this order when setting the activity state to an activity which is created according to the given activity template. If it is not set, the parameter is not modified.

participants

@UESQueryAttribute

private participants

Set of participants who can set activity state according to this template. If it is set to the value SYSTEM, it cannot contain any other value in the given set. If it is not specified, the parameter is not modified.

digitalWorkspaceVisibility

@UESQueryAttribute

private digitalWorkspaceVisibility

Set of roles which will get a digital workspace record in their digital workspace in the case when an activity is set to the state which is created according to this activity state template. If it is set to the value NOBODY, it cannot contain any other value in the given set. If it is not specified, the parameter is not modified.

Constructor Detail

UESActivityStateTemplateSetAttributes

public UESActivityStateTemplateSetAttributes()

Empty constructor.

Since:

UES8-07

UESActivityStateTemplateSetAttributes

public UESActivityStateTemplateSetAttributes(java.lang.String name,
java.lang.String code,
java.lang.String description,
UESActivityStateSubtype subtype,
java.lang.Boolean entryState,
java.lang.Boolean exitState,
UESURI iconUri,
java.lang.Integer order,
UESActivityStateParticipant[] participants,
UESActivityStateVisibility[] digitalWorkspaceVisibility)

Full constructor.

Since:

UES8-07