cz.ues.core.workflow.dto

Class UESActivityCreate

java.lang.Object

cz.ues.core.workflow.dto.UESActivityCreate

@DTO
public class UESActivityCreate
extends java.lang.Object

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
private UESActivityType	activityType Specifies the type of the new activity.
private java.lang.Boolean	allowExecutiveRoleChange Specifies if it will be possible to change an executive role of the new activity in the future.
private java.lang.Boolean	allowSubactivities Specifies if it will be possible to create new child activities on the new activity in the future.
private java.lang.Boolean	blockTimeInCalendar Specifies if the calendar should block the time for the time of meeting.
private java.lang.String	code Code of the new activity.
private UESURI	competentRoleUri The competent role for the activity.
private java.lang.Object	dateExpiration Specifies the date when the activity is automatically finished.
private java.util.Date	dateFrom Specifies the date when the activity is shown in the related users digital workspace.
private java.util.Date	dateStart Specifies the start of the meeting.
private java.util.Date	dateTo Specifies the date when the activity should be finished.
private java.lang.String	description Description of the new activity.
private UESURI[]	executiveRoleUris The executive role or roles of the new activity.
private java.lang.Boolean	isCompetentRoleParticipating Specifies if the root activity should be created as a cover activity, in case child activites are created.
private java.lang.String	name Name of the new activity.
private java.lang.Boolean	notify Specifies whether users who are cast in executiveRoleUris will be notified of the new activity in their Digital Workspace and by e-mail (if they have enabled e-mail notifications in their personal settings).
private java.lang.String	parameters Data containing additional information for a macro or other processing tool.
private UESURI	relatedArtifactUri Deprecated. Since UES7-08, use attribute relatedObjectUri.
private UESURI	relatedObjectUri Related object of the new activity.
private UESURI	templateUri UESURI of the activity template.

Constructor Summary

Constructors

Constructor and Description
UESActivityCreate(UESActivityType activityType) * Minimal constructor for the activity creation using activity type.
UESActivityCreate(UESActivityType activityType, java.lang.String name, java.util.Date dateStart, java.util.Date dateTo, UESURI[] executiveRoleUris) Enough constructor for the activity creation using activity type.
UESActivityCreate(UESActivityType activityType, java.lang.String name, java.lang.String code, java.lang.String description, java.util.Date dateFrom, java.util.Date dateStart, java.util.Date dateTo, java.lang.Object dateExpiration, UESURI competentRoleUri, UESURI[] executiveRoleUris, UESURI relatedObjectUri, java.lang.Boolean allowExecutiveRoleChange, java.lang.Boolean allowSubactivities, java.lang.Boolean blockTimeInCalendar, java.lang.Boolean isCompetentRoleParticipating, java.lang.Boolean notify, java.lang.String parameters) Maximal constructor for the activity creation using UESActivityType.
UESActivityCreate(UESActivityType activityType, java.lang.String name, java.lang.String code, java.lang.String description, java.util.Date dateFrom, java.util.Date dateStart, java.util.Date dateTo, UESURI competentRoleUri, UESURI[] executiveRoleUris, UESURI relatedObjectUri, java.lang.Boolean allowExecutiveRoleChange, java.lang.Boolean allowSubactivities, java.lang.Boolean blockTimeInCalendar, java.lang.Boolean isCompetentRoleParticipating, java.lang.Boolean notify) A constructor before adding the attribute dateExpiration.
UESActivityCreate(UESActivityType activityType, java.lang.String name, java.lang.String code, java.lang.String description, java.util.Date dateFrom, java.util.Date dateTo, UESURI competentRoleUri, UESURI[] executiveRoleUris) Constructor for the activity creation using activity type.
UESActivityCreate(UESURI templateUri) * Minimal constructor for the activity creation using UESURI of activity template.
UESActivityCreate(UESURI templateUri, java.lang.String name, java.util.Date dateStart, java.util.Date dateTo, UESURI[] executiveRoleUris) Enough constructor for the activity creation using UESURI of activity template.
UESActivityCreate(UESURI templateUri, java.lang.String name, java.lang.String code, java.lang.String description, java.util.Date dateFrom, java.util.Date dateStart, java.util.Date dateTo, java.lang.Object dateExpiration, UESURI competentRoleUri, UESURI[] executiveRoleUris, UESURI relatedObjectUri, java.lang.Boolean allowExecutiveRoleChange, java.lang.Boolean allowSubactivities, java.lang.Boolean blockTimeInCalendar, java.lang.Boolean isCompetentRoleParticipating, java.lang.Boolean notify, java.lang.String parameters) Maximal constructor for the activity creation using UESURI of activity template.
UESActivityCreate(UESURI templateUri, java.lang.String name, java.lang.String code, java.lang.String description, java.util.Date dateFrom, java.util.Date dateStart, java.util.Date dateTo, UESURI competentRoleUri, UESURI[] executiveRoleUris, UESURI relatedObjectUri, java.lang.Boolean allowExecutiveRoleChange, java.lang.Boolean allowSubactivities, java.lang.Boolean blockTimeInCalendar, java.lang.Boolean isCompetentRoleParticipating, java.lang.Boolean notify) A constructor before adding the attribute dateExpiration.
UESActivityCreate(UESURI templateUri, java.lang.String name, java.lang.String code, java.lang.String description, java.util.Date dateFrom, java.util.Date dateTo, UESURI competentRoleUri, UESURI[] executiveRoleUris) Constructor for the activity creation using UESURI of activity template.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

templateUri

private templateUri

UESURI of the activity template. The template determines the type of the new activity. When null is set, the template is determined by the type attribute (which cannot be null in that case).

Since:

UES6-00

activityType

private activityType

Specifies the type of the new activity. When null is set, the activity type is determined by the template (templateUri attribute, which cannot be null in that case).

Since:

UES6-00

name

private name

Name of the new activity. When null is set, the name is taken from the template tName. When the template does not define a tDescription, the create command fails.

Since:

UES6-00

code

private code

Code of the new activity. When null is set, the code is generated automatically using the system sequence. The code must be unique in a given artifact, otherwise the create command fails.

Since:

UES6-00

description

private description

Description of the new activity. When null is set, the description is taken from the template tDescription. When the template does not define a tDescription, it is left empty.

Since:

UES6-00

dateFrom

private dateFrom

Specifies the date when the activity is shown in the related users digital workspace. When null is set, the actual date (00:00) is used for all types of activities except of an activity of type RESERVE_TIME or COVER_MEETING. In that case, parent's dateFrom is used. If it is null, the actual time is used (but if the actual time is later than dateStart of the activity, dateStart is set as dateFrom instead). Subactivity specifics: Always the dateFrom of the parent is used.

Since:

UES6-00

dateStart

private dateStart

Specifies the start of the meeting. Cannot be null for an activity of type RESERVE_TIME or COVER_MEETING, has to be null for all other types of activities. Date must be in iso8601 format.

Since:

UES6-00

dateTo

private dateTo

Specifies the date when the activity should be finished. When null is set, the date is determined by the template settings. Cannot be null for an activity of type RESERVE_TIME or COVER_MEETING.
Subactivity specifics: The date must greater than parent's dateFrom and less or equal to parent's dateTo. When it is not possible to resolve dateFrom of parent activity, dateTo must be null. Date must be in iso8601 format.

Since:

UES6-00

dateExpiration

private dateExpiration

Specifies the date when the activity is automatically finished. This parameter is an object and it can contain three possible types of values: If it's a Date, it sets the activity to expire at that date. Such a date has to be after the dateTo attribute. If it's set to false, the activity will never expire (expiration is forbidden). If it's null, then the date is determined by the template settings. Subactivity specifics: The date has to be less or equal to parent's dateExpiration. When it is not possible to resolve dateFrom of parent activity, dateExpiration must be null. Date must be in iso8601 format.

Since:

UES8-02

competentRoleUri

private competentRoleUri

The competent role for the activity. When null is set, the result of authorization is used.
Subactivity specifics: Null must be set at creation subactivity (the competent role is taken from parent activity).

Since:

UES6-00

executiveRoleUris

private executiveRoleUris

The executive role or roles of the new activity. Role or group role could be used. When more than one role is specified or when a group role is used, the command creates a delegation for every role.
When null is set, the same role as for competentRoleUri is used.
Subactivity specifics: When null is set at creation subactivity, the command fails.

Since:

UES6-00

relatedArtifactUri

@Deprecated

private relatedArtifactUri

Deprecated. Since UES7-08, use attribute relatedObjectUri.

Deprecated since UES7-08 use attribute relatedObjectUri. Related artifact of the new activity. When null is set, the related artifact is taken from the template. When the template does not define it, it is left empty.

Since:

UES6-00

relatedObjectUri

private relatedObjectUri

Related object of the new activity. When null is set, the related object is taken from the template. When the template does not define it, it is left empty.

Since:

UES7-08

allowExecutiveRoleChange

private allowExecutiveRoleChange

Specifies if it will be possible to change an executive role of the new activity in the future. When null is set, is taken from the template. Cannot be false for an activity of type RESERVE_TIME or COVER_MEETING.

Since:

UES6-00

allowSubactivities

private allowSubactivities

Specifies if it will be possible to create new child activities on the new activity in the future. When null is set, is taken from the template. Cannot be false for an activity of type RESERVE_TIME or COVER_MEETING.

Since:

UES6-00

blockTimeInCalendar

private blockTimeInCalendar

Specifies if the calendar should block the time for the time of meeting. Only for an activity of type RESERVE_TIME or COVER_MEETING. When null is set, is taken from the template.

Since:

UES6-00

See Also:

UESActivityType}

isCompetentRoleParticipating

private isCompetentRoleParticipating

Specifies if the root activity should be created as a cover activity, in case child activites are created. When null is set, it is true. Only for an activity of type RESERVE_TIME or COVER_MEETING.

Since:

UES6-00

See Also:

UESActivityType}

notify

private notify

Specifies whether users who are cast in executiveRoleUris will be notified of the new activity in their Digital Workspace and by e-mail (if they have enabled e-mail notifications in their personal settings). If null is set, notifications will be enabled so the users will be notified.

Since:

UES6-06

parameters

private parameters

Data containing additional information for a macro or other processing tool. Value is a UTF-8 string with the maximum size of 4000 bytes.

Since:

UES8-12

Constructor Detail

UESActivityCreate

public UESActivityCreate(UESURI templateUri)

* Minimal constructor for the activity creation using UESURI of activity template.

Warning: Use this constructor carefully because it is need perfect defined attributes of the specified activity template. The command fails when some mandatory attribute (name, date, ...) is not defined on the specified activity template. (final UESActivityType activityType, final String name, final String code, final String description, final Date dateFrom, final Date dateStart, final Date dateTo, final Object dateExpiration, final UESURI competentRoleUri, final UESURI[] executiveRoleUris, final UESURI relatedObjectUri, final Boolean allowExecutiveRoleChange, final Boolean allowSubactivities, final Boolean blockTimeInCalendar, final Boolean isCompetentRoleParticipating, final Boolean notify)

Since:

UES7-10

UESActivityCreate

public UESActivityCreate(UESActivityType activityType)

* Minimal constructor for the activity creation using activity type.

Warning: Use this constructor carefully because it is need perfect defined attributes of the activity template that is found by activity type. The command fails when some mandatory attribute (name, date, ...) is not defined on the specified activity template.

Since:

UES7-10

UESActivityCreate

public UESActivityCreate(UESURI templateUri,
java.lang.String name,
java.util.Date dateStart,
java.util.Date dateTo,
UESURI[] executiveRoleUris)

Enough constructor for the activity creation using UESURI of activity template. This constructor extends minimal constructor and covers eventually missing mandatory attributes of the specified template.

In case of using activity template type such as "reserve time" or "meeting" the dateStart attribute must not be null. For all other activity template types the dateStart attribute must be null.

In case creation subactivity the executiveRoleUris must not be null. For root activity the result of authorization is used.

Since:

UES7-10

UESActivityCreate

public UESActivityCreate(UESActivityType activityType,
java.lang.String name,
java.util.Date dateStart,
java.util.Date dateTo,
UESURI[] executiveRoleUris)

Enough constructor for the activity creation using activity type. This constructor extends minimal constructor and covers eventually missing mandatory attributes of the specified template that is found by activity type.

In case of using activity type such as "RESERVE_TIME" or "COVER_MEETING" the dateStart attribute must not be null. For all other activity template types the dateStart attribute must be null.

In case creation subactivity the executiveRoleUris must not be null. For root activity the result of authorization is used.

Since:

UES7-10

UESActivityCreate

public UESActivityCreate(UESURI templateUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
java.util.Date dateFrom,
java.util.Date dateTo,
UESURI competentRoleUri,
UESURI[] executiveRoleUris)

Constructor for the activity creation using UESURI of activity template.

In case creation subactivity the executiveRoleUris must not be null. For root activity the result of authorization is used.

Since:

UES6-00

UESActivityCreate

public UESActivityCreate(UESActivityType activityType,
java.lang.String name,
java.lang.String code,
java.lang.String description,
java.util.Date dateFrom,
java.util.Date dateTo,
UESURI competentRoleUri,
UESURI[] executiveRoleUris)

Constructor for the activity creation using activity type.

In case creation subactivity the executiveRoleUris must not be null. For root activity the result of authorization is used.

Since:

UES6-00

UESActivityCreate

public UESActivityCreate(UESURI templateUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
java.util.Date dateFrom,
java.util.Date dateStart,
java.util.Date dateTo,
UESURI competentRoleUri,
UESURI[] executiveRoleUris,
UESURI relatedObjectUri,
java.lang.Boolean allowExecutiveRoleChange,
java.lang.Boolean allowSubactivities,
java.lang.Boolean blockTimeInCalendar,
java.lang.Boolean isCompetentRoleParticipating,
java.lang.Boolean notify)

A constructor before adding the attribute dateExpiration. It stays here because of backward compatibility.

Recommendation: Read description of all attributes for activity creation very carefully before using this constructor.

Since:

UES7-10

UESActivityCreate

public UESActivityCreate(UESURI templateUri,
java.lang.String name,
java.lang.String code,
java.lang.String description,
java.util.Date dateFrom,
java.util.Date dateStart,
java.util.Date dateTo,
java.lang.Object dateExpiration,
UESURI competentRoleUri,
UESURI[] executiveRoleUris,
UESURI relatedObjectUri,
java.lang.Boolean allowExecutiveRoleChange,
java.lang.Boolean allowSubactivities,
java.lang.Boolean blockTimeInCalendar,
java.lang.Boolean isCompetentRoleParticipating,
java.lang.Boolean notify,
java.lang.String parameters)

Maximal constructor for the activity creation using UESURI of activity template. This constructor allows to set all possible activity attributes.

Recommendation: Read description of all attributes for activity creation very carefully before using this constructor.

Since:

UES8-02

UESActivityCreate

public UESActivityCreate(UESActivityType activityType,
java.lang.String name,
java.lang.String code,
java.lang.String description,
java.util.Date dateFrom,
java.util.Date dateStart,
java.util.Date dateTo,
UESURI competentRoleUri,
UESURI[] executiveRoleUris,
UESURI relatedObjectUri,
java.lang.Boolean allowExecutiveRoleChange,
java.lang.Boolean allowSubactivities,
java.lang.Boolean blockTimeInCalendar,
java.lang.Boolean isCompetentRoleParticipating,
java.lang.Boolean notify)

A constructor before adding the attribute dateExpiration. It stays here because of backward compatibility.

Recommendation: Read description of all attributes for activity creation very carefully before using this constructor.

Since:

UES7-10

UESActivityCreate

public UESActivityCreate(UESActivityType activityType,
java.lang.String name,
java.lang.String code,
java.lang.String description,
java.util.Date dateFrom,
java.util.Date dateStart,
java.util.Date dateTo,
java.lang.Object dateExpiration,
UESURI competentRoleUri,
UESURI[] executiveRoleUris,
UESURI relatedObjectUri,
java.lang.Boolean allowExecutiveRoleChange,
java.lang.Boolean allowSubactivities,
java.lang.Boolean blockTimeInCalendar,
java.lang.Boolean isCompetentRoleParticipating,
java.lang.Boolean notify,
java.lang.String parameters)

Maximal constructor for the activity creation using UESActivityType. This constructor allows to set all possible activity attributes.

Recommendation: Read description of all attributes for activity creation very carefully before using this constructor.

Since:

UES8-02