Module: UU::OS::Activity
- Extended by:
- Activity
- Included in:
- Activity
- Defined in:
- uu_os-0.29.16/lib/uu/os/activity.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_type.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_create.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_set_state.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_attributes.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_state_type.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_state_subtype.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_set_attributes.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_state_attributes.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_get_instance_list.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_get_activity_list.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_set_executive_role.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_set_competent_role.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_get_state_history_list.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_get_state_template_list.rb,
uu_os-0.29.16/lib/uu/os/activity/activity_state_template_attributes.rb
Overview
Module Activity.
Defined Under Namespace
Classes: ActivityAttributes, ActivityCreate, ActivityGetActivityList, ActivityGetInstanceList, ActivityGetStateHistoryList, ActivityGetStateTemplateList, ActivitySetAttributes, ActivitySetCompetentRole, ActivitySetExecutiveRole, ActivitySetState, ActivityStateAttributes, ActivityStateSubtype, ActivityStateTemplateAttributes, ActivityStateType, ActivityType
Constant Summary
- PATH =
Service path
'ues/core/workflow/UESActivity'
Instance Method Summary (collapse)
-
- (UU::OS::UESURI) create(parent_node_uri, activity = nil)
This command creates a new activity on the specified artifact.
-
- (Object) delete(activity_uri)
This command deletes an unfinished activity.
-
- (UU::OS::REST::ResultList<Activity::ActivityGetActivityList, Activity::ActivityAttributes>) get_activity_list(parent_node_uri, criteria = nil)
Returns list of the activities and sub activities for the specified artifact or activity.
-
- (ActivityAttributes) get_attributes(activity_uri)
This command returns attributes representing the activity specified by the activityUri parameter.
-
- (UU::OS::REST::ResultList<Activity::ActivityGetInstanceList, Activity::ActivityAttributes>) get_instance_list(activity_uri, criteria = nil)
Returns list of all instances of the recurrent activity.
-
- (UU::OS::REST::ResultList<Activity::ActivityGetStateHistoryList, Activity::ActivityStateAttributes>) get_state_history_list(activity_uri, criteria = nil)
Retrieves the list of set states on a given activity based on provided criteria.
-
- (UU::OS::REST::ResultList<Activity::ActivityGetStateTemplateList, Activity::ActivityStateTemplateAttributes>) get_state_template_list(activity_uri, criteria = nil)
Returns a list of activity state templates which can be set by the current user for the specified activity.
-
- (UU::OS::UESURI) set_attributes(activity_uri, activity = nil)
This command updates some basic attributes of an activity.
-
- (Object) set_competent_role(activity_uri, activity = nil)
This command sets new competent role for the specified activity.
-
- (Object) set_executive_role(activity_uri, activity = nil)
This command sets new executive role for the specified activity.
-
- (Object) set_state(activity_uri, activity = nil)
This command sets a new state for the specified activity.
Instance Method Details
- (UU::OS::UESURI) create(parent_node_uri, activity = nil)
This command creates a new activity on the specified artifact. At the very least activity template or the activity type have to be specified in this command. Attention: No activity actions or conditions are copied from the template when the new activity is created by templateUri.
174 175 176 177 178 179 180 181 182 |
# File 'uu_os-0.29.16/lib/uu/os/activity.rb', line 174 def create(parent_node_uri, activity = nil) svc = UU::OS::REST::RemoteClient.new(Activity) payload = UU::OS::Activity::ActivityCreate.new(activity).to_json UU::OS::QoS::QoSHandler.auto_retry do res = svc.post('create', parent_node_uri, payload) return UU::OS::UESURI.new(res) end end |
- (Object) delete(activity_uri)
This command deletes an unfinished activity. Planned activity will be removed from the system, activity in progress will be set to the canceled state.
239 240 241 242 243 244 |
# File 'uu_os-0.29.16/lib/uu/os/activity.rb', line 239 def delete(activity_uri) svc = UU::OS::REST::RemoteClient.new(Activity) UU::OS::QoS::QoSHandler.auto_retry do svc.post('delete', activity_uri) end end |
- (UU::OS::REST::ResultList<Activity::ActivityGetActivityList, Activity::ActivityAttributes>) get_activity_list(parent_node_uri, criteria = nil)
Returns list of the activities and sub activities for the specified artifact or activity. Returned list does not contain any objects filtered out by executed UESQuery.
284 285 286 287 288 289 290 291 292 293 294 295 |
# File 'uu_os-0.29.16/lib/uu/os/activity.rb', line 284 def get_activity_list(parent_node_uri, criteria = nil) svc = UU::OS::REST::RemoteClient.new(Activity) dto = Activity::ActivityGetActivityList.new(criteria) svc.add_parameter('pageIndex', dto.page_index) svc.add_parameter('pageSize', dto.page_size) svc.add_parameter('query', dto.query) svc.add_parameter('recursive', dto.recursive) UU::OS::QoS::QoSHandler.auto_retry do res = svc.get('getActivityList', parent_node_uri) return UU::OS::REST::ResultList.new(Activity::ActivityGetActivityList, Activity::ActivityAttributes, res) end end |
- (ActivityAttributes) get_attributes(activity_uri)
This command returns attributes representing the activity specified by the activityUri parameter. The command does not change the state of the activity in the system.
101 102 103 104 105 106 107 |
# File 'uu_os-0.29.16/lib/uu/os/activity.rb', line 101 def get_attributes(activity_uri) svc = UU::OS::REST::RemoteClient.new(Activity) UU::OS::QoS::QoSHandler.auto_retry do res = svc.get('getAttributes', activity_uri) return Activity::ActivityAttributes.new(res) end end |
- (UU::OS::REST::ResultList<Activity::ActivityGetInstanceList, Activity::ActivityAttributes>) get_instance_list(activity_uri, criteria = nil)
Returns list of all instances of the recurrent activity. Returned list does not contain any objects filtered out by executed UESQuery.
257 258 259 260 261 262 263 264 265 266 267 |
# File 'uu_os-0.29.16/lib/uu/os/activity.rb', line 257 def get_instance_list(activity_uri, criteria = nil) svc = UU::OS::REST::RemoteClient.new(Activity) dto = Activity::ActivityGetInstanceList.new(criteria) svc.add_parameter('pageIndex', dto.page_index) svc.add_parameter('pageSize', dto.page_size) svc.add_parameter('query', dto.query) UU::OS::QoS::QoSHandler.auto_retry do res = svc.get('getInstanceList', activity_uri) return UU::OS::REST::ResultList.new(Activity::ActivityGetInstanceList, Activity::ActivityAttributes, res) end end |
- (UU::OS::REST::ResultList<Activity::ActivityGetStateHistoryList, Activity::ActivityStateAttributes>) get_state_history_list(activity_uri, criteria = nil)
Retrieves the list of set states on a given activity based on provided criteria.
311 312 313 314 315 316 317 318 319 320 |
# File 'uu_os-0.29.16/lib/uu/os/activity.rb', line 311 def get_state_history_list(activity_uri, criteria = nil) svc = UU::OS::REST::RemoteClient.new(Activity) dto = Activity::ActivityGetStateHistoryList.new(criteria) svc.add_parameter('pageIndex', dto.page_index) svc.add_parameter('pageSize', dto.page_size) UU::OS::QoS::QoSHandler.auto_retry do res = svc.get('getStateHistoryList', activity_uri) return UU::OS::REST::ResultList.new(Activity::ActivityGetStateHistoryList, Activity::ActivityStateAttributes, res) end end |
- (UU::OS::REST::ResultList<Activity::ActivityGetStateTemplateList, Activity::ActivityStateTemplateAttributes>) get_state_template_list(activity_uri, criteria = nil)
Returns a list of activity state templates which can be set by the current user for the specified activity.
333 334 335 336 337 338 339 340 341 342 343 |
# File 'uu_os-0.29.16/lib/uu/os/activity.rb', line 333 def get_state_template_list(activity_uri, criteria = nil) svc = UU::OS::REST::RemoteClient.new(Activity) dto = Activity::ActivityGetStateTemplateList.new(criteria) svc.add_parameter('pageIndex', dto.page_index) svc.add_parameter('pageSize', dto.page_size) svc.add_parameter('query', dto.query) UU::OS::QoS::QoSHandler.auto_retry do res = svc.get('getStateTemplateList', activity_uri) return UU::OS::REST::ResultList.new(Activity::ActivityGetStateTemplateList, Activity::ActivityStateTemplateAttributes, res) end end |
- (UU::OS::UESURI) set_attributes(activity_uri, activity = nil)
This command updates some basic attributes of an activity.
220 221 222 223 224 225 226 227 228 |
# File 'uu_os-0.29.16/lib/uu/os/activity.rb', line 220 def set_attributes(activity_uri, activity = nil) svc = UU::OS::REST::RemoteClient.new(Activity) payload = UU::OS::Activity::ActivitySetAttributes.new(activity).to_json UU::OS::QoS::QoSHandler.auto_retry do res = svc.post('setAttributes', activity_uri, payload) return UU::OS::UESURI.new(res) end end |
- (Object) set_competent_role(activity_uri, activity = nil)
This command sets new competent role for the specified activity.
60 61 62 63 64 65 66 67 |
# File 'uu_os-0.29.16/lib/uu/os/activity.rb', line 60 def set_competent_role(activity_uri, activity = nil) svc = UU::OS::REST::RemoteClient.new(Activity) payload = UU::OS::Activity::ActivitySetCompetentRole.new(activity).to_json UU::OS::QoS::QoSHandler.auto_retry do svc.post('setCompetentRole', activity_uri, payload) end end |
- (Object) set_executive_role(activity_uri, activity = nil)
This command sets new executive role for the specified activity.
78 79 80 81 82 83 84 85 |
# File 'uu_os-0.29.16/lib/uu/os/activity.rb', line 78 def set_executive_role(activity_uri, activity = nil) svc = UU::OS::REST::RemoteClient.new(Activity) payload = UU::OS::Activity::ActivitySetExecutiveRole.new(activity).to_json UU::OS::QoS::QoSHandler.auto_retry do svc.post('setExecutiveRole', activity_uri, payload) end end |
- (Object) set_state(activity_uri, activity = nil)
This command sets a new state for the specified activity. You can enter the state template using ues uri or by specifying its type and, additionally, subtype.
42 43 44 45 46 47 48 49 |
# File 'uu_os-0.29.16/lib/uu/os/activity.rb', line 42 def set_state(activity_uri, activity = nil) svc = UU::OS::REST::RemoteClient.new(Activity) payload = UU::OS::Activity::ActivitySetState.new(activity).to_json UU::OS::QoS::QoSHandler.auto_retry do svc.post('setState', activity_uri, payload) end end |