Interface | osid.workflow.rules.StepProcessorOfficeSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupStepProcessorOfficeMappings | ||
Description |
Tests if this user can perform lookups of step
processor/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 | useComparativeStepProcessorOfficeView | ||
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 | usePlenaryStepProcessorOfficeView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getStepProcessorIdsByOffice | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | officeId | Id of the Office |
Return | osid.id.IdList | list of related step processor 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 | getStepProcessorsByOffice | ||
Description |
Gets the list of step processors associated with an
| ||
Parameters | osid.id.Id | officeId | Id of the Office |
Return | osid.workflow.rules.StepProcessorList | list of related step processors | |
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 | getStepProcessorIdsByOffices | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | officeIds | list of office Ids |
Return | osid.id.IdList | list of step processor 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 | getStepProcessorsByOffices | ||
Description |
Gets the list of step processor corresponding to a list
of | ||
Parameters | osid.id.IdList | officeIds | list of office Ids |
Return | osid.workflow.rules.StepProcessorList | list of step processors | |
Errors | NULL_ARGUMENT | officeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOfficeIdsByStepProcessor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | stepProcessorId | Id of a StepProcessor |
Return | osid.id.IdList | list of offices | |
Errors | NOT_FOUND | stepProcessorId is not found | |
NULL_ARGUMENT | stepProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOfficesByStepProcessor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | stepProcessorId | Id of a StepProcessor |
Return | osid.workflow.OfficeList | list of offices | |
Errors | NOT_FOUND | stepProcessorId is not found | |
NULL_ARGUMENT | stepProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |