OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.rules.HoldEnablerLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving HoldEnablers.

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 oubliette view: All hold enabler methods in this session operate, retrieve and pertain to hold enablers defined explicitly in the current oubliette. Using an isolated view is useful for managing HoldEnablers with the HoldEnablerAdminSession.
  • federated oubliette view: All hold enabler methods in this session operate, retrieve and pertain to all hold enablers defined in this oubliette and any other hold enablers implicitly available in this oubliette through oubliette inheritence.
  • active hold enabler view: All hold enabler lookup methods return active hold enablers.
  • any active hold enabler view: Hold enablers of any active or inactive status are returned from methods.
MethodgetOublietteId
Description

Gets the Oubliette Id associated with this session.

Returnosid.id.Idthe Oubliette Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOubliette
Description

Gets the Oubliette associated with this session.

Returnosid.hold.Oubliettethe oubliette
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupHoldEnablers
Description

Tests if this user can perform HoldEnablers 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.
MethoduseComparativeHoldEnablerView
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.
MethodusePlenaryHoldEnablerView
Description

A complete view of the HoldEnabler 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.
MethoduseFederatedOublietteView
Description

Federates the view for methods in this session. A federated view will include hold enablers in oubliettes which are children of this oubliette in the oubliette hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedOublietteView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseActiveHoldEnablerView
Description

Only active hold enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusHoldEnablerView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetHoldEnabler
Description

Gets the HoldEnabler specified by its Id.

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

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

Parametersosid.id.IdholdEnablerId Id of the HoldEnabler
Returnosid.hold.rules.HoldEnablerthe hold enabler
ErrorsNOT_FOUND holdEnablerId not found
NULL_ARGUMENT holdEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetHoldEnablersByIds
Description

Gets a HoldEnablerList corresponding to the given IdList.

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

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

Parametersosid.id.IdListholdEnablerIdsthe list of Ids to retrieve
Returnosid.hold.rules.HoldEnablerListthe returned HoldEnabler list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT holdEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablersByGenusType
Description

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

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

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

Parametersosid.type.TypeholdEnablerGenusTypea hold enabler genus type
Returnosid.hold.rules.HoldEnablerListthe returned HoldEnabler list
ErrorsNULL_ARGUMENT holdEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablersByParentGenusType
Description

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

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

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

Parametersosid.type.TypeholdEnablerGenusTypea hold enabler genus type
Returnosid.hold.rules.HoldEnablerListthe returned HoldEnabler list
ErrorsNULL_ARGUMENT holdEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablersByRecordType
Description

Gets a HoldEnablerList containing the given hold enabler record Type.

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

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

Parametersosid.type.TypeholdEnablerRecordTypea hold enabler record type
Returnosid.hold.rules.HoldEnablerListthe returned HoldEnabler list
ErrorsNULL_ARGUMENT holdEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablersOnDate
Description

Gets a HoldEnablerList 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 hold enablers or an error results. Otherwise, the returned list may contain only those hold enablers that are accessible through this session.

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

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.hold.rules.HoldEnablerListthe returned HoldEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablersOnDateWithAgent
Description

Gets a HoldEnablerList 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 hold enablers or an error results. Otherwise, the returned list may contain only those hold enablers that are accessible through this session.

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

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.hold.rules.HoldEnablerListthe returned HoldEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT agentId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablers
Description

Gets all HoldEnablers.

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

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

Returnosid.hold.rules.HoldEnablerListthe returned HoldEnabler list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.