Interface | osid.workflow.WorkLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
Method | getOfficeId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Office Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOffice | ||
Description |
Gets the | ||
Return | osid.workflow.Office | the office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupWorks | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeWorkView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryWorkView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedOfficeView | ||
Description |
Federates the view for methods in this session. A federated view will include works in offices which are children of this office in the office hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedOfficeView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this office only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getWork | ||
Description |
Gets the | ||
Parameters | osid.id.Id | workId | Id of the Work |
Return | osid.workflow.Work | the work | |
Errors | NOT_FOUND | workId not found | |
NULL_ARGUMENT | workId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getWorksByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | workIds | the list of Ids to retrieve |
Return | osid.workflow.WorkList | the returned Work list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | workIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorksByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | workGenusType | a work genus type |
Return | osid.workflow.WorkList | the returned Work list | |
Errors | NULL_ARGUMENT | workGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorksByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | workGenusType | a work genus type |
Return | osid.workflow.WorkList | the returned Work list | |
Errors | NULL_ARGUMENT | workGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorksByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | workRecordType | a work record type |
Return | osid.workflow.WorkList | the returned Work list | |
Errors | NULL_ARGUMENT | workRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWorks | ||
Description |
Gets all | ||
Return | osid.workflow.WorkList | a list of Works | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |