Interface | osid.workflow.rules.StepConstrainerEnablerLookupSession | ||
---|---|---|---|
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 | canLookupStepConstrainerEnablers | ||
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 | useComparativeStepConstrainerEnablerView | ||
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 | usePlenaryStepConstrainerEnablerView | ||
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 step constrainer enablers 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 | useActiveStepConstrainerEnablerView | ||
Description |
Only active step constrainer enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusStepConstrainerEnablerView | ||
Description |
All active and inactive step constrainer enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getStepConstrainerEnabler | ||
Description |
Gets the In active mode, step constrainer enablers are returned that are currently active. In any status mode, active and inactive step constrainer enablers are returned. | ||
Parameters | osid.id.Id | stepConstrainerEnablerId | Id of the StepConstrainerEnabler |
Return | osid.workflow.rules.StepConstrainerEnabler | the step constrainer enabler | |
Errors | NOT_FOUND | stepConstrainerEnablerId not found | |
NULL_ARGUMENT | stepConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getStepConstrainerEnablersByIds | ||
Description |
Gets a In active mode, step constrainer enablers are returned that are currently active. In any status mode, active and inactive step constrainer enablers are returned. | ||
Parameters | osid.id.IdList | stepConstrainerEnablerIds | the list of Ids to retrieve |
Return | osid.workflow.rules.StepConstrainerEnablerList | the returned StepConstrainerEnabler list | |
Errors | NOT_FOUND | a Id was not found | |
NULL_ARGUMENT | stepConstrainerEnablerIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerEnablersByGenusType | ||
Description |
Gets a In active mode, step constrainer enablers are returned that are currently active. In any status mode, active and inactive step constrainer enablers are returned. | ||
Parameters | osid.type.Type | stepConstrainerEnablerGenusType | a step constrainer enabler genus type |
Return | osid.workflow.rules.StepConstrainerEnablerList | the returned StepConstrainerEnabler list | |
Errors | NULL_ARGUMENT | stepConstrainerEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerEnablersByParentGenusType | ||
Description |
Gets a In active mode, step constrainer enablers are returned that are currently active. In any status mode, active and inactive step constrainer enablers are returned. | ||
Parameters | osid.type.Type | stepConstrainerEnablerGenusType | a step constrainer enabler genus type |
Return | osid.workflow.rules.StepConstrainerEnablerList | the returned StepConstrainerEnabler list | |
Errors | NULL_ARGUMENT | stepConstrainerEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerEnablersByRecordType | ||
Description |
Gets a In active mode, step constrainer enablers are returned that are currently active. In any status mode, active and inactive step constrainer enablers are returned. | ||
Parameters | osid.type.Type | stepConstrainerEnablerRecordType | a step constrainer enabler record type |
Return | osid.workflow.rules.StepConstrainerEnablerList | the returned StepConstrainerEnabler list | |
Errors | NULL_ARGUMENT | stepConstrainerEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerEnablersOnDate | ||
Description |
Gets a In active mode, step constrainer enablers are returned that are currently active. In any status mode, active and inactive step constrainer enablers are returned. | ||
Parameters | osid.calendaring.DateTime | from | a start date |
osid.calendaring.DateTime | to | an end date | |
Return | osid.workflow.rules.StepConstrainerEnablerList | the returned StepConstrainerEnabler list | |
Errors | INVALID_ARGUMENT | from is greater tha to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerEnablersOnDateWithAgent | ||
Description |
Gets a In active mode, step constrainer enablers are returned that are currently active. In any status mode, active and inactive step constrainer enablers are returned. | ||
Parameters | osid.id.Id | agentId | an agent Id |
osid.calendaring.DateTime | from | a start date | |
osid.calendaring.DateTime | to | an end date | |
Return | osid.workflow.rules.StepConstrainerEnablerList | the returned StepConstrainerEnabler list | |
Errors | INVALID_ARGUMENT | from is greater tha to | |
NULL_ARGUMENT | agentId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStepConstrainerEnablers | ||
Description |
Gets all In plenary mode, the returned list contains all known step constrainer enablers or an error results. Otherwise, the returned list may contain only those step constrainer enablers that are accessible through this session. In active mode, step constrainer enablers are returned that are currently active. In any status mode, active and inactive step constrainer enablers are returned. | ||
Return | osid.workflow.rules.StepConstrainerEnablerList | the returned StepConstrainerEnabler list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |