Interface HoldEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface HoldEnablerLookupSession
extends OsidSession

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.

Method Summary

Modifier and Type	Method	Description
boolean	canLookupHoldEnablers()	Tests if this user can perform HoldEnablers lookups.
HoldEnabler	getHoldEnabler(Id holdEnablerId)	Gets the HoldEnabler specified by its Id .
HoldEnablerList	getHoldEnablers()	Gets all HoldEnablers .
HoldEnablerList	getHoldEnablersByGenusType(Type holdEnablerGenusType)	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 .
HoldEnablerList	getHoldEnablersByIds(IdList holdEnablerIds)	Gets a HoldEnablerList corresponding to the given IdList .
HoldEnablerList	getHoldEnablersByParentGenusType(Type holdEnablerGenusType)	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 .
HoldEnablerList	getHoldEnablersByRecordType(Type holdEnablerRecordType)	Gets a HoldEnablerList containing the given hold enabler record Type .
HoldEnablerList	getHoldEnablersOnDate(DateTime from, DateTime to)	Gets a HoldEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
HoldEnablerList	getHoldEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	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.
Oubliette	getOubliette()	Gets the Oubliette associated with this session.
Id	getOublietteId()	Gets the Oubliette Id associated with this session.
void	useActiveHoldEnablerView()	Only active hold enablers are returned by methods in this session.
void	useAnyStatusHoldEnablerView()	All active and inactive hold enablers are returned by methods in this session.
void	useComparativeHoldEnablerView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedOublietteView()	Federates the view for methods in this session.
void	useIsolatedOublietteView()	Isolates the view for methods in this session.
void	usePlenaryHoldEnablerView()	A complete view of the HoldEnabler returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getOublietteId

Id getOublietteId()

Gets the Oubliette Id associated with this session.

Returns:

the Oubliette Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOubliette

Oubliette getOubliette()
                throws OperationFailedException,
PermissionDeniedException

Gets the Oubliette associated with this session.

Returns:

the oubliette

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupHoldEnablers

boolean canLookupHoldEnablers()

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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeHoldEnablerView

void useComparativeHoldEnablerView()

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.

usePlenaryHoldEnablerView

void usePlenaryHoldEnablerView()

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.

Compliance:

mandatory - This method is must be implemented.

useFederatedOublietteView

void useFederatedOublietteView()

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.

Compliance:

mandatory - This method is must be implemented.

useIsolatedOublietteView

void useIsolatedOublietteView()

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

Compliance:

mandatory - This method is must be implemented.

useActiveHoldEnablerView

void useActiveHoldEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyStatusHoldEnablerView

void useAnyStatusHoldEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getHoldEnabler

HoldEnabler getHoldEnabler(Id holdEnablerId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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.

Parameters:

holdEnablerId - Id of the HoldEnabler

Returns:

the hold enabler

Throws:

NotFoundException - holdEnablerId not found

NullArgumentException - holdEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getHoldEnablersByIds

HoldEnablerList getHoldEnablersByIds(IdList holdEnablerIds)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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.

Parameters:

holdEnablerIds - the list of Ids to retrieve

Returns:

the returned HoldEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - holdEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHoldEnablersByGenusType

HoldEnablerList getHoldEnablersByGenusType(Type holdEnablerGenusType)
                                    throws OperationFailedException,
PermissionDeniedException

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.

Parameters:

holdEnablerGenusType - a hold enabler genus type

Returns:

the returned HoldEnabler list

Throws:

NullArgumentException - holdEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHoldEnablersByParentGenusType

HoldEnablerList getHoldEnablersByParentGenusType(Type holdEnablerGenusType)
                                          throws OperationFailedException,
PermissionDeniedException

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.

Parameters:

holdEnablerGenusType - a hold enabler genus type

Returns:

the returned HoldEnabler list

Throws:

NullArgumentException - holdEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHoldEnablersByRecordType

HoldEnablerList getHoldEnablersByRecordType(Type holdEnablerRecordType)
                                     throws OperationFailedException,
PermissionDeniedException

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.

Parameters:

holdEnablerRecordType - a hold enabler record type

Returns:

the returned HoldEnabler list

Throws:

NullArgumentException - holdEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHoldEnablersOnDate

HoldEnablerList getHoldEnablersOnDate(DateTime from,
 DateTime to)
                               throws OperationFailedException,
PermissionDeniedException

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.

Parameters:

from - a start date

to - an end date

Returns:

the returned HoldEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHoldEnablersOnDateWithAgent

HoldEnablerList getHoldEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                        throws OperationFailedException,
PermissionDeniedException

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.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned HoldEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - agentId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHoldEnablers

HoldEnablerList getHoldEnablers()
                         throws OperationFailedException,
PermissionDeniedException

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.

Returns:

the returned HoldEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.