Interface | osid.workflow.StepOfficeSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupStepOfficeMappings | ||
Description |
Tests if this user can perform lookups of step/office
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known lookup methods in this session will result in a
| ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeStepOfficeView | ||
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 | usePlenaryStepOfficeView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getStepIdsByOffice | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | officeId | Id of the Office |
Return | osid.id.IdList | list of related step Ids | |
Errors | NOT_FOUND | officeId is not found | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepesByOffice | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | officeId | Id of the Office |
Return | osid.workflow.StepList | list of related steps | |
Errors | NOT_FOUND | officeId is not found | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepIdsByOffices | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | officeIds | list of office Ids |
Return | osid.id.IdList | list of step Ids | |
Errors | NULL_ARGUMENT | officeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepsByOffices | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | officeIds | list of office Ids |
Return | osid.workflow.StepList | list of steps | |
Errors | NULL_ARGUMENT | officeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOfficeIdsByStep | ||
Description |
Gets the | ||
Parameters | osid.id.Id | stepId | Id of a Step |
Return | osid.id.IdList | list of offices | |
Errors | NOT_FOUND | stepId is not found | |
NULL_ARGUMENT | stepId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOfficesByStep | ||
Description |
Gets the | ||
Parameters | osid.id.Id | stepId | Id of a Step |
Return | osid.workflow.OfficeList | list of offices | |
Errors | NOT_FOUND | stepId is not found | |
NULL_ARGUMENT | stepId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |