Class: UU::OS::Activity::ActivitySetAttributes

Inherits:
REST::DTO
  • Object
show all
Defined in:
uu_os_client-0.10.6/lib/uu/os/activity/activity_set_attributes.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) allow_executive_role_change

Specifies if it will be possible to change an executive role of the activity in the future. When null is set, this flag is not modified.



57
58
59
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_set_attributes.rb', line 57

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 activity in the future. When null is set, this flag is not modified.



61
62
63
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_set_attributes.rb', line 61

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 activities type TIME_RESERVATION or COVER_MEETING. When null is set, this flag is not modified. @see UESActivityType



66
67
68
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_set_attributes.rb', line 66

def block_time_in_calendar
  @block_time_in_calendar
end

- (Object) code

The new code of the activity. When null is set, the code is not modified. The code must be unique in a given artifact, otherwise the setAttributes command fails.



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

def code
  @code
end

- (Object) competent_role_uri

The new competent role for the activity. When null is set, it is not modified.



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

def competent_role_uri
  @competent_role_uri
end

- (Object) date_expiration

Specifies the date when the activity is automatically finished. If null is set, the date is determined by the template settings. 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.



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

def date_expiration
  @date_expiration
end

- (Object) date_from

Specifies the date when the activity is shown in the related users digital workspace. Date must be in iso8601 format.



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

def date_from
  @date_from
end

- (Object) date_start

The new start of the meeting. Could be specified only for activities of type TIME_RESERVATION or COVER_MEETING. When null is set, it is not modified.
Subactivity specifics: Always the date must be null. @see UESActivityType Date must be in iso8601 format.



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

def date_start
  @date_start
end

- (Object) date_to

The new date when the activity should be finished. When null is set, it is not modified. Date must be in iso8601 format.



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

def date_to
  @date_to
end

- (Object) description

The new description of the activity. When null is set, the description is not modified.



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

def description
  @description
end

- (Object) executive_role_uri

The new executive role of the activity. When null is set, it is not modified.
Subactivity specifics: Null must be set at creation subactivity (the competent role is taken from parent activity).



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

def executive_role_uri
  @executive_role_uri
end

- (Object) name

The new name of the activity. When null is set, the name is not modified.



12
13
14
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_set_attributes.rb', line 12

def name
  @name
end

- (Object) notify

Specifies if all related users will be notified of the modified 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 modified activity executive role (or one of roles in case of cover activity).



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

def notify
  @notify
end

- (Object) related_artifact_uri

The new related artifact of the activity. When null is set, the related artifact reference is not modified. When NULL_URI is set, the related artifact is set empty.
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.



49
50
51
 
# File 'uu_os_client-0.10.6/lib/uu/os/activity/activity_set_attributes.rb', line 49

def related_artifact_uri
  @related_artifact_uri
end

- (Object) related_object_uri

The new related object of the activity. When null is set, the related object reference is not modified. When NULL_URI is set, the related artifact is set empty.



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

def related_object_uri
  @related_object_uri
end