Module: UU::DigitalWorkspace::DigitalWorkspace

Extended by:
DigitalWorkspace
Included in:
DigitalWorkspace
Defined in:
uu_digitalworkspace_client-0.8.6/lib/uu/digital_workspace/digital_workspace.rb,
uu_digitalworkspace_client-0.8.6/lib/uu/digital_workspace/digital_workspace/digital_workspace_get_record_list.rb,
uu_digitalworkspace_client-0.8.6/lib/uu/digital_workspace/digital_workspace/digital_workspace_record_attributes.rb

Defined Under Namespace

Classes: DigitalWorkspaceGetRecordList, DigitalWorkspaceRecordAttributes

Constant Summary

PATH =

Service path

'ues/digitalworkspace/digitalworkspace/UESDigitalWorkspace'

Instance Method Summary (collapse)

Instance Method Details

- (Object) get_active_record_list(role_uri, criteria = nil)

The command returns list of active digital workspace records enlisted in the specified role's digital workspace (entity type of main entity of the command could be a Role or Access Role). Command does not return all entries, only a sublist. The list of returned entries could be filtered by the name and date of creation of an entry, by the type, state type, state subtype, competent role, executive role, date of start and date of expected completion of activity which is represented by the entry and also by the name of artifact the represented activity is aggregated to. The list is sorted by the date from (and name in case are equal) of a entry by default, or it can be sorted arbitrarily by any of entry attributes usable for the filtering or these attributes combinations. See the UES query documentation for more information.

See UESQuery Documentation.

Parameters:

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

    UESURI of the role / access role for which digital workspace records will be returned

  • criteria (DigitalWorkspaceGetRecordList) (defaults to: nil) —

    DTO containing criteria for listing task list entries. Available parameters are: name, dateFrom, dateStart, dateTo, dateCompleted, activityType, activityStateType, activityStateSubtype, competentRoleName, executiveRoleName and artifactName

Returns:

  • List of DTO representing digital workspace records.



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'uu_digitalworkspace_client-0.8.6/lib/uu/digital_workspace/digital_workspace.rb', line 40

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

- (Object) get_archive_record_list(role_uri, criteria = nil)

The command returns list of archive digital workspace records enlisted in the specified role's digital workspace (entity type of main entity of the command could be a Role or Access Role). Command does not return all entries, only a sublist. The list of returned entries could be filtered by the name and date of creation of an entry, by the type, state type, state subtype, competent role, executive role, date of start and date of expected completion of activity which is represented by the entry and also by the name of artifact the represented activity is aggregated to. The list is sorted by the date from (and name in case are equal) of a entry by default, or it can be sorted arbitrarily by any of entry attributes usable for the filtering or these attributes combinations. See the UES query documentation for more information.

See UESQuery Documentation.

Parameters:

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

    UESURI of the role / access role for which digital workspace records will be returned

  • criteria (DigitalWorkspaceGetRecordList) (defaults to: nil) —

    DTO containing criteria for listing task list entries. Available parameters are: name, dateFrom, dateStart, dateTo, dateCompleted, activityType, activityStateType, activityStateSubtype, competentRoleName, executiveRoleName and artifactName

Returns:

  • List of DTO representing digital workspace records.



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'uu_digitalworkspace_client-0.8.6/lib/uu/digital_workspace/digital_workspace.rb', line 78

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