public interface AvailabilityEnablerLookupSession extends OsidSession
This session provides methods for retrieving
AvailabilityEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
AvailabilityEnablers
with the
AvailabilityEnablerAdminSession.
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 useFederatedFoundryView()
and
useIsolatedFoundryView()
behave as a radio group and one should be
selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAvailabilityEnablers()
Tests if this user can perform
AvailabilityEnablers
lookups. |
AvailabilityEnabler |
getAvailabilityEnabler(Id availabilityEnablerId)
Gets the
AvailabilityEnabler specified by its
Id. |
AvailabilityEnablerList |
getAvailabilityEnablers()
Gets all
AvailabilityEnablers. |
AvailabilityEnablerList |
getAvailabilityEnablersByGenusType(Type availabilityEnablerGenusType)
Gets an
AvailabilityEnablerList corresponding to the
given availability enabler genus Type which does not
include availability enabler of genus types derived from the specified
Type. |
AvailabilityEnablerList |
getAvailabilityEnablersByIds(IdList availabilityEnablerIds)
Gets a
AvailabilityEnablerList corresponding to the
given IdList. |
AvailabilityEnablerList |
getAvailabilityEnablersByParentGenusType(Type availabilityEnablerGenusType)
Gets an
AvailabilityEnablerList corresponding to the
given availability enabler genus Type and include any
additional availability enabler with genus types derived from the
specified Type. |
AvailabilityEnablerList |
getAvailabilityEnablersByRecordType(Type availabilityEnablerRecordType)
Gets an
AvailabilityEnablerList containing the given
availability enabler record Type. |
AvailabilityEnablerList |
getAvailabilityEnablersOnDate(DateTime from,
DateTime to)
Gets an
AvailabilityEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range for any agent. |
AvailabilityEnablerList |
getAvailabilityEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets an
AvailabilityEnablerList that are effective for
the entire given date range and evaluated against the given agent. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
useActiveAvailabilityEnablerView()
Only active availability enablers are returned by methods in this
session.
|
void |
useAnyStatusAvailabilityEnablerView()
All active and inactive availability enablers are returned by methods
in this session.
|
void |
useComparativeAvailabilityEnablerView()
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 |
useFederatedFoundryView()
Federates the view for methods in this session.
|
void |
useIsolatedFoundryView()
Isolates the view for methods in this session.
|
void |
usePlenaryAvailabilityEnablerView()
A complete view of the
AvailabilityEnabler returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupAvailabilityEnablers()
AvailabilityEnablers
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 useComparativeAvailabilityEnablerView()
mandatory
- This method is must be implemented. void usePlenaryAvailabilityEnablerView()
AvailabilityEnabler
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 useFederatedFoundryView()
mandatory
- This method is must be implemented. void useIsolatedFoundryView()
mandatory
- This method is must be implemented. void useActiveAvailabilityEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusAvailabilityEnablerView()
mandatory
- This method is must be implemented. AvailabilityEnabler getAvailabilityEnabler(Id availabilityEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AvailabilityEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
AvailabilityEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a AvailabilityEnabler
and retained for
compatibility.
In active mode, availability enablers are returned that are currently
active. In any status mode, active and inactive availability enablers
are returned.availabilityEnablerId
- Id
of the
AvailabilityEnabler
NotFoundException
- availabilityEnablerrId
not foundNullArgumentException
- availabilityEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. AvailabilityEnablerList getAvailabilityEnablersByIds(IdList availabilityEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AvailabilityEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
availability enabler 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 AvailabilityEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, availability enablers are returned that are currently
active. In any status mode, active and inactive availability enablers
are returned.availabilityEnablerIds
- the list of Ids
to
retrieve AvailabilityEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- availabilityEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityEnablerList getAvailabilityEnablersByGenusType(Type availabilityEnablerGenusType) throws OperationFailedException, PermissionDeniedException
AvailabilityEnablerList
corresponding to the
given availability enabler genus Type
which does not
include availability enabler of genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
availability enabler or an error results. Otherwise, the returned list
may contain only those availability enabler that are accessible
through this session.
In active mode, availability enablers are returned that are currently
active. In any status mode, active and inactive availability enablers
are returned.availabilityEnablerGenusType
- an availability enabler genus
type AvailabilityEnabler
listNullArgumentException
-
availabilityEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityEnablerList getAvailabilityEnablersByParentGenusType(Type availabilityEnablerGenusType) throws OperationFailedException, PermissionDeniedException
AvailabilityEnablerList
corresponding to the
given availability enabler genus Type
and include any
additional availability enabler with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
availability enabler or an error results. Otherwise, the returned list
may contain only those availability enabler that are accessible
through this session.
In active mode, availability enablers are returned that are currently
active. In any status mode, active and inactive availability enablers
are returned.availabilityEnablerGenusType
- an availability enabler genus
type AvailabilityEnabler
listNullArgumentException
-
availabilityEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityEnablerList getAvailabilityEnablersByRecordType(Type availabilityEnablerRecordType) throws OperationFailedException, PermissionDeniedException
AvailabilityEnablerList
containing the given
availability enabler record Type.
In plenary mode, the returned list contains all known
availability enabler or an error results. Otherwise, the returned list
may contain only those availability enabler that are accessible
through this session.
In active mode, availability enablers are returned that are currently
active. In any status mode, active and inactive availability enablers
are returned.availabilityEnablerRecordType
- an availability enabler record
type AvailabilityEnabler
listNullArgumentException
-
availabilityEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityEnablerList getAvailabilityEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AvailabilityEnablerList
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 availability
enablers or an error results. Otherwise, the returned list may contain
only those availability enablers that are accessible through this
session.
In active mode, availability enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive availability enablers are
returned.from
- a start dateto
- an end date AvailabilityEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from,
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityEnablerList getAvailabilityEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AvailabilityEnablerList
that are effective for
the entire given date range and evaluated against the given agent.
In plenary mode, the returned list contains all known availability
enablers or an error results. Otherwise, the returned list may contain
only those availability enablers that are accessible through this
session.
In active mode, availability enablers are returned that are currently
active in addition to being effective ib the given date range for the
given agent. In any status mode, active and inactive availability
enablers are returned.agentId
- an agent Id
from
- a start dateto
- an end date AvailabilityEnabler
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. AvailabilityEnablerList getAvailabilityEnablers() throws OperationFailedException, PermissionDeniedException
AvailabilityEnablers.
In plenary mode, the returned list contains all known availability
enabler or an error results. Otherwise, the returned list may contain
only those availability enabler that are accessible through this
session.
In active mode, availability enablers are returned that are currently
active. In any status mode, active and inactive availability enablers
are returned. AvailabilityEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.