Class: UU::OS::Activity::ActivityAttributes

Inherits:
REST::DTO
  • Object
show all
Defined in:
uu_os-0.29.16/lib/uu/os/activity/activity_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) activity_state_comment

Comment of the current activity state. Nil for planned activities. Nil for planned activity.



85
86
87
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 85

def activity_state_comment
  @activity_state_comment
end

- (Object) activity_state_name

Name of the activity state. It is set (from activity state template) when the activity state is set. Nil for planned activities. Nil for planned activity.



89
90
91
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 89

def activity_state_name
  @activity_state_name
end

- (Object) activity_state_subtype

Subtype of the current activity state. Nil for planned activity. @see UU::OS::Activity::ActivityStateSubtype



81
82
83
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 81

def activity_state_subtype
  @activity_state_subtype
end

- (Object) activity_state_type

Type of the current activity state. Nil for planned activity. @see UU::OS::Activity::ActivityStateType



78
79
80
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 78

def activity_state_type
  @activity_state_type
end

- (Object) activity_type

Type of the activity. See UESActivityType for details. Never nil. Nil if the parameter templateUri is set. @see UU::OS::Activity::ActivityType



18
19
20
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 18

def activity_type
  @activity_type
end

- (Object) allow_executive_role_change

Specifies if it is allowed to change the executive role of the activity. Never nil.



68
69
70
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 68

def allow_executive_role_change
  @allow_executive_role_change
end

- (Object) allow_subactivities

Specifies if it is allowed to create new subactivities on the activity. Never nil.



71
72
73
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 71

def allow_subactivities
  @allow_subactivities
end

- (Object) block_time_in_calendar

Specifies if the activity of type TIME_RESERVATION blocks time in the calendar. Nil for activities of all other types. @see UU::OS::Activity::ActivityType



75
76
77
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 75

def block_time_in_calendar
  @block_time_in_calendar
end

- (Object) code

Code of the activity. Never nil.



28
29
30
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 28

def code
  @code
end

- (Object) competent_role_uri

Normalized UESURI of the competent role of the activity (submitter of the activity). Never nil.



55
56
57
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 55

def competent_role_uri
  @competent_role_uri
end

- (Object) date_expiration

Date when the activity is automatically finished. The date of expiration is always after the dateTo attribute.



51
52
53
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 51

def date_expiration
  @date_expiration
end

- (Object) date_finished

When the activity was finished. It is not any longer show in the tasklist after this date. Note that activityStateType does not have to be in FINAL or similar state in that case (because dateFinished is also driven by the parent activity). Nil if the activity is not finished yet.



37
38
39
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 37

def date_finished
  @date_finished
end

- (Object) date_from

Date from which the activity is shown in the tasklist.



40
41
42
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 40

def date_from
  @date_from
end

- (Object) date_start

Date from which the executive role should perform the activity. It could be different from dateFrom only for activity type TIME_RESERVATION or COVER_MEETING so far.

See Also:

  • {UESActivityType}


45
46
47
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 45

def date_start
  @date_start
end

- (Object) date_to

Date when the executive role should have finished the activity.



48
49
50
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 48

def date_to
  @date_to
end

- (Object) description

Description of the activity. Never nil.



31
32
33
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 31

def description
  @description
end

- (Object) entity_type_uri

UESURI of the entity type of the activity. Never nil.



98
99
100
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 98

def entity_type_uri
  @entity_type_uri
end

- (Object) executive_role_uri

Normalized UESURI of the executive role of the activity (solver of the activity). Never nil.



59
60
61
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 59

def executive_role_uri
  @executive_role_uri
end

- (Object) name

Name of the activity. Never nil.



25
26
27
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 25

def name
  @name
end

- (Object) parameters

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



101
102
103
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 101

def parameters
  @parameters
end

- (Object) parent_activity_uri

Normalized UESURI of the parent activity. Nil if the activity has no parent activity (when it is located directly on the artifact).



22
23
24
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 22

def parent_activity_uri
  @parent_activity_uri
end

- (Object) recurrent

Identifies whether the activity is recurrent in time.



92
93
94
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 92

def recurrent
  @recurrent
end

Related artifact of the activity. Nil if it is not specified.



62
63
64
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 62

def related_artifact_uri
  @related_artifact_uri
end

Related object of the activity. Nil if it is not specified.



65
66
67
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 65

def related_object_uri
  @related_object_uri
end

- (Object) template_uri

Normalized UESURI of the activity template. Nil if the parameter activityType is set.



14
15
16
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 14

def template_uri
  @template_uri
end

- (Object) uri

Normalized UESURI of the activity. Never nil.



10
11
12
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 10

def uri
  @uri
end

- (Object) version

Version of the activity.



95
96
97
# File 'uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb', line 95

def version
  @version
end