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

This session provides methods for retrieving StepConstrainers.

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 methods in this session operate, retrieve and pertain to step constrainer defined explicitly in the current office. Using an isolated view is useful for managing StepConstrainers with the StepConstrainerAdminSession.
  • federated office view: All step constrainer methods in this session operate, retrieve and pertain to all step constrainer defined in this office and any other step constrainer implicitly available in this office through office inheritence.
  • active step constrainer view: All step constrainer lookup methods return active step constrainers.
  • any status step constrainer view: Step constrainers 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.
MethodcanLookupStepConstrainers
Description

Tests if this user can perform StepConstrainers 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.
MethoduseComparativeStepConstrainerView
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.
MethodusePlenaryStepConstrainerView
Description

A complete view of the StepConstrainer 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 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.
MethoduseActiveStepConstrainerView
Description

Only active step constrainers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusStepConstrainerView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetStepConstrainer
Description

Gets the StepConstrainer specified by its Id.

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

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

Parametersosid.id.IdstepConstrainerId Id of the StepConstrainer
Returnosid.workflow.rules.StepConstrainerthe step constrainer
ErrorsNOT_FOUND stepConstrainerId not found
NULL_ARGUMENT stepConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetStepConstrainersByIds
Description

Gets a StepConstrainerList corresponding to the given IdList.

In plenary mode, the returned list contains all of the step constrainer 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 StepConstrainers may be omitted from the list and may present the elements in any order including returning a unique set.

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

Parametersosid.id.IdListstepConstrainerIdsthe list of Ids to retrieve
Returnosid.workflow.rules.StepConstrainerListthe returned StepConstrainer list
ErrorsNOT_FOUNDa Id was not found
NULL_ARGUMENT stepConstrainerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainersByGenusType
Description

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

In plenary mode, the returned list contains all known step constrainer or an error results. Otherwise, the returned list may contain only those step constrainer that are accessible through this session.

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

Parametersosid.type.TypestepConstrainerGenusTypea step constrainer genus type
Returnosid.workflow.rules.StepConstrainerListthe returned StepConstrainer list
ErrorsNULL_ARGUMENT stepConstrainerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainersByParentGenusType
Description

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

In plenary mode, the returned list contains all known step constrainer or an error results. Otherwise, the returned list may contain only those step constrainer that are accessible through this session.

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

Parametersosid.type.TypestepConstrainerGenusTypea step constrainer genus type
Returnosid.workflow.rules.StepConstrainerListthe returned StepConstrainer list
ErrorsNULL_ARGUMENT stepConstrainerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainersByRecordType
Description

Gets a StepConstrainerList containing the given step constrainer record Type.

In plenary mode, the returned list contains all known step constrainer or an error results. Otherwise, the returned list may contain only those step constrainer that are accessible through this session.

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

Parametersosid.type.TypestepConstrainerRecordTypea step constrainer record type
Returnosid.workflow.rules.StepConstrainerListthe returned StepConstrainer list
ErrorsNULL_ARGUMENT stepConstrainerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainers
Description

Gets all StepConstrainers.

In plenary mode, the returned list contains all known step constrainer or an error results. Otherwise, the returned list may contain only those step constrainer that are accessible through this session.

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

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