Module: UU::DigitalWorkspace::DigitalWorkspace

Extended by:
DigitalWorkspace
Included in:
DigitalWorkspace
Defined in:
uu_digitalworkspace-0.27.16/lib/uu/digital_workspace/digital_workspace.rb,
uu_digitalworkspace-0.27.16/lib/uu/digital_workspace/digital_workspace/digital_workspace_get_record_list.rb,
uu_digitalworkspace-0.27.16/lib/uu/digital_workspace/digital_workspace/digital_workspace_record_attributes.rb,
uu_digitalworkspace-0.27.16/lib/uu/digital_workspace/digital_workspace/digital_workspace_set_record_attributes.rb

Defined Under Namespace

Classes: DigitalWorkspaceGetRecordList, DigitalWorkspaceRecordAttributes, DigitalWorkspaceSetRecordAttributes

Constant Summary

PATH =

Service path

'ues/digitalworkspace/digitalworkspace/UESDigitalWorkspace'

Instance Method Summary (collapse)

Instance Method Details

- (UU::OS::REST::ResultList<DigitalWorkspace::DigitalWorkspaceRecordAttributes, DigitalWorkspace::DigitalWorkspaceGetRecordList>) get_active_record_list(role_uri, criteria = nil)

Returns list of active Digital Workspace Records in the specified Role's (or Access Role's) Digital Workspace. The command does not return all entries, only a sublist filtered by the query criteria. The list is sorted by default based on the date and name of each entry.

Examples:

#Get a list of all active Digital Workspace Records with dateFrom between 2009-06-22T11:00:00+02:00 and 2009-07-30T11:00:00+02:00 
UU::DigitalWorkspace::DigitalWorkspace.get_active_record_list("ues:TERRITORY:ROLE_URI", 
:query=>"dateFrom> '2009-06-22T11:00:00+02:00' and dateFrom < '2009-07-30T11:00:00+02:00'", :recursive=>true)

Parameters:

Options Hash (criteria):

  • :query (String) —

    Query for filtering and ordering of the result list (more information in uuQuery - Guideline). It is possible to filter the result list by name (String), dateFrom (String in ISO 8601 format), dateStart (String in ISO format), dateTo (String in ISO 8601 format), dateExpiration (String in ISO 8601 format), activityType (OS::Activity::ActivityType), activityStateType (OS::Activity::ActivityStateType), activityStateSubtype (OS::Activity::ActivityStateSubtype), competentRoleName (String), executiveRoleName (String), artifactName (String), isNew (Boolean), isUnread (Boolean) and pending (Boolean).

  • :recursive (String) —

    Flag for recursive listing. It means that if recursive flag is true, all records of activities are in result. If the recursive flag is nil or false, only entries directly delegated/executed by the selected role are returned without the ones aggregated through cast roles.

Returns:



31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'uu_digitalworkspace-0.27.16/lib/uu/digital_workspace/digital_workspace.rb', line 31

def get_active_record_list(role_uri, criteria = nil)
  svc = UU::OS::REST::RemoteClient.new(DigitalWorkspace)
  dto = DigitalWorkspace::DigitalWorkspaceGetRecordList.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('getActiveRecordList', role_uri)
    return UU::OS::REST::ResultList.new(DigitalWorkspace::DigitalWorkspaceGetRecordList, DigitalWorkspace::DigitalWorkspaceRecordAttributes, res)
  end
end

- (UU::OS::REST::ResultList<DigitalWorkspace::DigitalWorkspaceRecordAttributes, DigitalWorkspace::DigitalWorkspaceGetRecordList>) get_archive_record_list(role_uri, criteria = nil)

Returns list of archive Digital Workspace Records in the specified Role's (or Access Role's) Digital Workspace.The command does not return all entries, only a sublist filtered by the query criteria. The list is sorted by the date and name of an entry by default.

Examples:

#Get a list of all archive records with dateTo after 2009-07-30T11:00:00+02:00
UU::DigitalWorkspace::DigitalWorkspace.get_archive_record_list("ues:TERRITORY:ROLE_URI", 
:query=>"dateTo > '2009-07-30T11:00:00+02:00'", :recursive=>true)

Parameters:

Options Hash (criteria):

  • :query (String) —

    Query for filtering and ordering of the result list (more information in uuQuery - Guideline). It is possible to filter the result list by name (String), dateFrom (String in ISO 8601 format), dateStart (String in ISO format), dateTo (String in ISO 8601 format), dateCompleted (String in ISO 8601 format), dateExpiration (String in ISO 8601 format), activityType (OS::Activity::ActivityType), activityStateType (OS::Activity::ActivityStateType), activityStateSubtype (OS::Activity::ActivityStateSubtype), competentRoleName (String), executiveRoleName (String) and artifactName (String).

  • :recursive (String) —

    Flag for recursive listing. It means that if recursive flag is true, all records of activities are in result. If the recursive flag is nil or false, only entries directly delegated/executed by the selected role are returned without the ones aggregated through cast roles.

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'uu_digitalworkspace-0.27.16/lib/uu/digital_workspace/digital_workspace.rb', line 58

def get_archive_record_list(role_uri, criteria = nil)
  svc = UU::OS::REST::RemoteClient.new(DigitalWorkspace)
  dto = DigitalWorkspace::DigitalWorkspaceGetRecordList.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('getArchiveRecordList', role_uri)
    return UU::OS::REST::ResultList.new(DigitalWorkspace::DigitalWorkspaceGetRecordList, DigitalWorkspace::DigitalWorkspaceRecordAttributes, res)
  end
end

- (UU::OS::UESURI) set_record_attributes(record_uri, record = nil)

Sets attributes of the DW Record which belongs to a Personal Role. DW Record can be modified only if it belongs to a Personal Role.

Examples:

#Set attribute isUnread to true
UU::DigitalWorkspace::DigitalWorkspace.set_record_attributes("ues:TERRITORY:ARTIFACT:RECORD", :is_unread=>true)

Parameters:

  • record_uri (String, UU::OS::UESURI) —

    • UESURI of the DW Record which belongs to a Personal Role. DW Record can be modified only if it belongs to a Personal Role.

  • record (DigitalWorkspaceRecordSetAttributes) (defaults to: nil) —

    • Object containing modified attributes of the DW Record

Options Hash (record):

  • :is_unread (Boolean) —

    Specifies whether the DW Record is marked as unread. If the record is marked as read, then it will not be marked as is_new anymore. If set to nil, the value will not be modified.

Returns:

  • (UU::OS::UESURI) —

    UESURI of the DW Record whose attributes are to be changed. UESURI is in the normalized form (with codes).



84
85
86
87
88
89
90
91
 
# File 'uu_digitalworkspace-0.27.16/lib/uu/digital_workspace/digital_workspace.rb', line 84

def set_record_attributes(record_uri, record = nil)
  svc = UU::OS::REST::RemoteClient.new(DigitalWorkspace)
  dto = DigitalWorkspace::DigitalWorkspaceSetRecordAttributes.new(record)
  UU::OS::QoS::QoSHandler.auto_retry do
    res = svc.post('setRecordAttributes', record_uri, dto)
    return UU::OS::UESURI.new(res)
  end
end