OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.StepConstrainerEnablerLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving StepConstrainerEnablers.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated office view: All step constrainer enabler methods in this session operate, retrieve and pertain to step constrainer enablers defined explicitly in the current office. Using an isolated view is useful for managing StepConstrainerEnablers with the StepConstrainerEnablerAdminSession.
  • federated office view: All step constrainer enabler methods in this session operate, retrieve and pertain to all step constrainer enablers defined in this office and any other step constrainer enablers implicitly available in this office through office inheritence.
  • active step constrainer enabler view: All step constrainer enabler lookup methods return active step constrainer enablers.
  • any active step constrainer enabler view: Step constrainer enablers of any active or inactive status are returned from methods.

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 useFederatedOfficeView() and useIsolatedOfficeView() behave as a radio group and one should be selected before invoking the methods in this session.

MethodgetOfficeId
Description

Gets the Office Id associated with this session.

Returnosid.id.Idthe Office Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOffice
Description

Gets the Office associated with this session.

Returnosid.workflow.Officethe office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupStepConstrainerEnablers
Description

Tests if this user can perform StepConstrainerEnablers lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeStepConstrainerEnablerView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryStepConstrainerEnablerView
Description

A complete view of the StepConstrainerEnabler returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedOfficeView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedOfficeView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this office only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveStepConstrainerEnablerView
Description

Only active step constrainer enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusStepConstrainerEnablerView
Description

All active and inactive step constrainer enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetStepConstrainerEnabler
Description

Gets the StepConstrainerEnabler specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned StepConstrainerEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a StepConstrainerEnabler and retained for compatibility.

In active mode, step constrainer enablers are returned that are currently active. In any status mode, active and inactive step constrainer enablers are returned.

Parametersosid.id.IdstepConstrainerEnablerId Id of the StepConstrainerEnabler
Returnosid.workflow.rules.StepConstrainerEnablerthe step constrainer enabler
ErrorsNOT_FOUND stepConstrainerEnablerId not found
NULL_ARGUMENT stepConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetStepConstrainerEnablersByIds
Description

Gets a StepConstrainerEnablerList corresponding to the given IdList.

In plenary mode, the returned list contains all of the step constrainer enablers specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible StepConstrainerEnablers may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, step constrainer enablers are returned that are currently active. In any status mode, active and inactive step constrainer enablers are returned.

Parametersosid.id.IdListstepConstrainerEnablerIdsthe list of Ids to retrieve
Returnosid.workflow.rules.StepConstrainerEnablerListthe returned StepConstrainerEnabler list
ErrorsNOT_FOUNDa Id was not found
NULL_ARGUMENT stepConstrainerEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablersByGenusType
Description

Gets a StepConstrainerEnablerList corresponding to the given step constrainer enabler genus Type which does not include step constrainer enablers of genus types derived from the specified Type.

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.

Parametersosid.type.TypestepConstrainerEnablerGenusTypea step constrainer enabler genus type
Returnosid.workflow.rules.StepConstrainerEnablerListthe returned StepConstrainerEnabler list
ErrorsNULL_ARGUMENT stepConstrainerEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablersByParentGenusType
Description

Gets a StepConstrainerEnablerList corresponding to the given step constrainer enabler genus Type and include any additional step constrainer enablers with genus types derived from the specified Type.

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.

Parametersosid.type.TypestepConstrainerEnablerGenusTypea step constrainer enabler genus type
Returnosid.workflow.rules.StepConstrainerEnablerListthe returned StepConstrainerEnabler list
ErrorsNULL_ARGUMENT stepConstrainerEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablersByRecordType
Description

Gets a StepConstrainerEnablerList containing the given step constrainer enabler record Type.

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.

Parametersosid.type.TypestepConstrainerEnablerRecordTypea step constrainer enabler record type
Returnosid.workflow.rules.StepConstrainerEnablerListthe returned StepConstrainerEnabler list
ErrorsNULL_ARGUMENT stepConstrainerEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablersOnDate
Description

Gets a StepConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.

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.

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.workflow.rules.StepConstrainerEnablerListthe returned StepConstrainerEnabler list
ErrorsINVALID_ARGUMENT from is greater tha to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablersOnDateWithAgent
Description

Gets a StepConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.

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.

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.workflow.rules.StepConstrainerEnablerListthe returned StepConstrainerEnabler list
ErrorsINVALID_ARGUMENT from is greater tha to
NULL_ARGUMENT agentId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablers
Description

Gets all StepConstrainerEnablers.

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.

Returnosid.workflow.rules.StepConstrainerEnablerListthe returned StepConstrainerEnabler list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.