Class: UU::OS::Activity::ActivityCreate

Inherits:
REST::DTO
  • Object
show all
Defined in:
uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb

Instance Attribute Summary (collapse)

Method Summary

Methods inherited from REST::DTO

#initialize, #to_hash, #to_json

Constructor Details

This class inherits a constructor from UU::OS::REST::DTO

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class UU::OS::REST::DTO

Instance Attribute Details

- (Object) activity_type

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).



19
20
21
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 19

def activity_type
  @activity_type
end

- (Object) allow_executive_role_change

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.



89
90
91
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 89

def allow_executive_role_change
  @allow_executive_role_change
end

- (Object) allow_subactivities

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.



94
95
96
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 94

def allow_subactivities
  @allow_subactivities
end

- (Object) block_time_in_calendar

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. @see UESActivityType



99
100
101
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 99

def block_time_in_calendar
  @block_time_in_calendar
end

- (Object) 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.



28
29
30
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 28

def code
  @code
end

- (Object) competent_role_uri

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).



68
69
70
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 68

def competent_role_uri
  @competent_role_uri
end

- (Object) date_expiration

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.



63
64
65
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 63

def date_expiration
  @date_expiration
end

- (Object) date_from

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.



41
42
43
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 41

def date_from
  @date_from
end

- (Object) date_start

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.



46
47
48
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 46

def date_start
  @date_start
end

- (Object) date_to

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 lesser or equal as parent's dateTo. When it is not possible to resolve dateFrom of parent activity, dateTo must be null. Date must be in iso8601 format.



54
55
56
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 54

def date_to
  @date_to
end

- (Object) 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.



33
34
35
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 33

def description
  @description
end

- (Object) executive_role_uris

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.



75
76
77
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 75

def executive_role_uris
  @executive_role_uris
end

- (Object) is_competent_role_participating

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. @see UESActivityType



104
105
106
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 104

def is_competent_role_participating
  @is_competent_role_participating
end

- (Object) 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.



23
24
25
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 23

def name
  @name
end

- (Object) notify

Specifies if all related users will be notified of the new activity. The notify is enabled by default, therefore when null is set, the users are notified.
Notified users are all the users with access role casted to the new activity executive role (or one of roles in case of cover activity). See executiveRoleUris attribute for more information.



111
112
113
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 111

def notify
  @notify
end

- (Object) related_artifact_uri

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.



80
81
82
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 80

def related_artifact_uri
  @related_artifact_uri
end

- (Object) related_object_uri

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.



84
85
86
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 84

def related_object_uri
  @related_object_uri
end

- (Object) template_uri

UESURI of the new 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). Attention: No activity actions or conditions are copied from the template when the new activity is created by templateUri.



15
16
17
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_create.rb', line 15

def template_uri
  @template_uri
end