public interface CommissionEnablerLookupSession extends OsidSession
This session provides methods for retrieving CommissionEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
CommissionEnablers
with the
CommissionEnablerAdminSession.
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 |
canLookupCommissionEnablers()
Tests if this user can perform
CommissionEnablers
lookups. |
CommissionEnabler |
getCommissionEnabler(Id commissionEnablerId)
Gets the
CommissionEnabler specified by its Id. |
CommissionEnablerList |
getCommissionEnablers()
Gets all
CommissionEnablers. |
CommissionEnablerList |
getCommissionEnablersByGenusType(Type commissionEnablerGenusType)
Gets a
CommissionEnablerList corresponding to the given
commission enabler genus Type which does not include
commission enabler of genus types derived from the specified
Type. |
CommissionEnablerList |
getCommissionEnablersByIds(IdList commissionEnablerIds)
Gets a
CommissionEnablerList corresponding to the given
IdList. |
CommissionEnablerList |
getCommissionEnablersByParentGenusType(Type commissionEnablerGenusType)
Gets a
CommissionEnablerList corresponding to the given
commission enabler genus Type and include any
additional commission enabler with genus types derived from the
specified Type. |
CommissionEnablerList |
getCommissionEnablersByRecordType(Type commissionEnablerRecordType)
Gets a
CommissionEnablerList containing the given
commission enabler record Type. |
CommissionEnablerList |
getCommissionEnablersOnDate(DateTime from,
DateTime to)
Gets a
CommissionEnablerList that are effective for the
entire given date range inclusive but not confined to the date range
for any agent. |
CommissionEnablerList |
getCommissionEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
CommissionEnablerList that are effective for the
entire given date range inclusive but not confined to the date range
and evaluated againstthe given agent. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
useActiveCommissionEnablerView()
Only active commission enablers are returned by methods in this
session.
|
void |
useAnyStatusCommissionEnablerView()
All active and inactive commission enablers are returned by methods in
this session.
|
void |
useComparativeCommissionEnablerView()
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 |
usePlenaryCommissionEnablerView()
A complete view of the
CommissionEnabler 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 canLookupCommissionEnablers()
CommissionEnablers
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 useComparativeCommissionEnablerView()
mandatory
- This method is must be implemented. void usePlenaryCommissionEnablerView()
CommissionEnabler
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 useActiveCommissionEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusCommissionEnablerView()
mandatory
- This method is must be implemented. CommissionEnabler getCommissionEnabler(Id commissionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CommissionEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
CommissionEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a CommissionEnabler
and retained for
compatibility.
In active mode, commission enablers are returned that are currently
active. In any status mode, active and inactive commission enablers
are returned.commissionEnablerId
- Id
of the
CommissionEnabler
NotFoundException
- commissionEnablerId
not foundNullArgumentException
- commissionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. CommissionEnablerList getCommissionEnablersByIds(IdList commissionEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CommissionEnablerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
commission enabler 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 CommissionEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, commission enablers are returned that are currently
active. In any status mode, active and inactive commission enablers
are returned.commissionEnablerIds
- the list of Ids
to
retrieve CommissionEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- commissionEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommissionEnablerList getCommissionEnablersByGenusType(Type commissionEnablerGenusType) throws OperationFailedException, PermissionDeniedException
CommissionEnablerList
corresponding to the given
commission enabler genus Type
which does not include
commission enabler of genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
commission enabler or an error results. Otherwise, the returned list
may contain only those commission enabler that are accessible through
this session.
In active mode, commission enablers are returned that are currently
active. In any status mode, active and inactive commission enablers
are returned.commissionEnablerGenusType
- a commission enabler genus type CommissionEnabler
listNullArgumentException
-
commissionEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommissionEnablerList getCommissionEnablersByParentGenusType(Type commissionEnablerGenusType) throws OperationFailedException, PermissionDeniedException
CommissionEnablerList
corresponding to the given
commission enabler genus Type
and include any
additional commission enabler with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
commission enabler or an error results. Otherwise, the returned list
may contain only those commission enabler that are accessible through
this session.
In active mode, commission enablers are returned that are currently
active. In any status mode, active and inactive commission enablers
are returned.commissionEnablerGenusType
- a commission enabler genus type CommissionEnabler
listNullArgumentException
-
commissionEnablerIdGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommissionEnablerList getCommissionEnablersByRecordType(Type commissionEnablerRecordType) throws OperationFailedException, PermissionDeniedException
CommissionEnablerList
containing the given
commission enabler record Type.
In plenary mode, the returned list contains all known
commission enabler or an error results. Otherwise, the returned list
may contain only those commission enabler that are accessible through
this session.
In active mode, commission enablers are returned that are currently
active. In any status mode, active and inactive commission enablers
are returned.commissionEnablerRecordType
- a commission enabler record type CommissionEnabler
listNullArgumentException
-
commissionEnablerRecordTYpe
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommissionEnablerList getCommissionEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CommissionEnablerList
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 commission
enablers or an error results. Otherwise, the returned list may contain
only those commission enablers that are accessible through this
session.
In active mode, commission enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive commission enablers are returned.from
- a start dateto
- an end date CommissionEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from,
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommissionEnablerList getCommissionEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
CommissionEnablerList
that are effective for the
entire given date range inclusive but not confined to the date range
and evaluated againstthe given agent.
In plenary mode, the returned list contains all known commission
enablers or an error results. Otherwise, the returned list may contain
only those commission enablers that are accessible through this
session.
In active mode, commission enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive commission enablers are returned.agentId
- an agent Id
from
- a start dateto
- an end date CommissionEnabler
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. CommissionEnablerList getCommissionEnablers() throws OperationFailedException, PermissionDeniedException
CommissionEnablers.
In plenary mode, the returned list contains all known commission
enabler or an error results. Otherwise, the returned list may contain
only those commission enabler that are accessible through this
session.
In active mode, commission enablers are returned that are currently
active. In any status mode, active and inactive commission enablers
are returned. CommissionEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.