public interface HoldEnablerLookupSession extends OsidSession
This session provides methods for retrieving HoldEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
HoldEnablers
with the HoldEnablerAdminSession.
Modifier and Type | Method and 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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOublietteId()
Oubliette
Id
associated with
this session. Oubliette Id
associated with this sessionmandatory
- This method must be implemented. Oubliette getOubliette() throws OperationFailedException, PermissionDeniedException
Oubliette
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupHoldEnablers()
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeHoldEnablerView()
mandatory
- This method is must be implemented. void usePlenaryHoldEnablerView()
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.mandatory
- This method is must be implemented. void useFederatedOublietteView()
mandatory
- This method is must be implemented. void useIsolatedOublietteView()
mandatory
- This method is must be implemented. void useActiveHoldEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusHoldEnablerView()
mandatory
- This method is must be implemented. HoldEnabler getHoldEnabler(Id holdEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.holdEnablerId
- Id
of the HoldEnabler
NotFoundException
- holdEnablerId
not
foundNullArgumentException
- holdEnablerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. HoldEnablerList getHoldEnablersByIds(IdList holdEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.holdEnablerIds
- the list of Ids
to retrieve HoldEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- holdEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. HoldEnablerList getHoldEnablersByGenusType(Type holdEnablerGenusType) throws OperationFailedException, PermissionDeniedException
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.holdEnablerGenusType
- a hold enabler genus type HoldEnabler
listNullArgumentException
- holdEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. HoldEnablerList getHoldEnablersByParentGenusType(Type holdEnablerGenusType) throws OperationFailedException, PermissionDeniedException
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.holdEnablerGenusType
- a hold enabler genus type HoldEnabler
listNullArgumentException
- holdEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. HoldEnablerList getHoldEnablersByRecordType(Type holdEnablerRecordType) throws OperationFailedException, PermissionDeniedException
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.holdEnablerRecordType
- a hold enabler record type HoldEnabler
listNullArgumentException
- holdEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. HoldEnablerList getHoldEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.from
- a start dateto
- an end date HoldEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. HoldEnablerList getHoldEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.agentId
- an agent Id
from
- a start dateto
- an end date HoldEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agentId, from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. HoldEnablerList getHoldEnablers() throws OperationFailedException, PermissionDeniedException
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. HoldEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.