public interface BrokerConstrainerEnablerLookupSession extends OsidSession
This session provides methods for retrieving
BrokerConstrainerEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
BrokerConstrainerEnablers
with the BrokerConstrainerEnablerAdminSession.
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 useFederatedDistributorView()
and
useIsolatedDistributorView()
behave as a radio group and one
should be selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupBrokerConstrainerEnablers()
Tests if this user can perform
BrokerConstrainerEnablers
lookups. |
BrokerConstrainerEnabler |
getBrokerConstrainerEnabler(Id brokerConstrainerEnablerId)
Gets the
BrokerConstrainerEnabler specified by its
Id. |
BrokerConstrainerEnablerList |
getBrokerConstrainerEnablers()
Gets all
BrokerConstrainerEnablers. |
BrokerConstrainerEnablerList |
getBrokerConstrainerEnablersByGenusType(Type brokerConstrainerEnablerGenusType)
Gets a
BrokerConstrainerEnablerList corresponding to
the given broker constrainer enabler genus Type which
does not include broker constrainer enablers of genus types derived
from the specified Type. |
BrokerConstrainerEnablerList |
getBrokerConstrainerEnablersByIds(IdList brokerConstrainerEnablerIds)
Gets a
BrokerConstrainerEnablerList corresponding to
the given IdList. |
BrokerConstrainerEnablerList |
getBrokerConstrainerEnablersByParentGenusType(Type brokerConstrainerEnablerGenusType)
Gets a
BrokerConstrainerEnablerList corresponding to
the given broker constrainer enabler genus Type and
include any additional broker constrainer enablers with genus types
derived from the specified Type. |
BrokerConstrainerEnablerList |
getBrokerConstrainerEnablersByRecordType(Type brokerConstrainerEnablerRecordType)
Gets a
BrokerConstrainerEnablerList containing the
given broker constrainer enabler record Type. |
BrokerConstrainerEnablerList |
getBrokerConstrainerEnablersOnDate(DateTime from,
DateTime to)
Gets a
BrokerConstrainerEnablerList effective for the
entire the given date range inclusive but not confisned to the date
range for any agent. |
BrokerConstrainerEnablerList |
getBrokerConstrainerEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
BrokerConstrainerEnablerList effective for the
entire the given date range inclusive but not confisned to the date
range and evaluated against the given agent. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
useActiveBrokerConstrainerEnablerView()
Only active broker constrainer enablers are current are returned by
methods in this session.
|
void |
useAnyStatusBrokerConstrainerEnablerView()
All active and inactive broker constrainer enablers are returned by
methods in this session.
|
void |
useComparativeBrokerConstrainerEnablerView()
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 |
useFederatedDistributorView()
Federates the view for methods in this session.
|
void |
useIsolatedDistributorView()
Isolates the view for methods in this session.
|
void |
usePlenaryBrokerConstrainerEnablerView()
A complete view of the
BrokerConstrainerEnabler returns
is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupBrokerConstrainerEnablers()
BrokerConstrainerEnablers
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 useComparativeBrokerConstrainerEnablerView()
mandatory
- This method is must be implemented. void usePlenaryBrokerConstrainerEnablerView()
BrokerConstrainerEnabler
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 useFederatedDistributorView()
mandatory
- This method is must be implemented. void useIsolatedDistributorView()
mandatory
- This method is must be implemented. void useActiveBrokerConstrainerEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusBrokerConstrainerEnablerView()
mandatory
- This method is must be implemented. BrokerConstrainerEnabler getBrokerConstrainerEnabler(Id brokerConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerConstrainerEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
BrokerConstrainerEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a BrokerConstrainerEnabler
and
retained for compatibility.
In active mode, broker constrainer enablers are returned that are
currently active. In any status mode, active and inactive broker
constrainer enablers are returned.brokerConstrainerEnablerId
- Id
of the
BrokerConstrainerEnabler
NotFoundException
- brokerConstrainerEnablerId
not foundNullArgumentException
-
brokerConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. BrokerConstrainerEnablerList getBrokerConstrainerEnablersByIds(IdList brokerConstrainerEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerConstrainerEnablerList
corresponding to
the given IdList.
In plenary mode, the returned list contains all of the
broker constrainer 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 BrokerConstrainerEnablers
may be omitted from the list and may present the elements in
any order including returning a unique set.
In active mode, broker constrainer enablers are returned that are
currently active. In any status mode, active and inactive broker
constrainer enablers are returned.brokerConstrainerEnablerIds
- the list of Ids
to
retrieve BrokerConstrainerEnabler
listNotFoundException
- an Id
was not foundNullArgumentException
-
brokerConstrainerEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerConstrainerEnablerList getBrokerConstrainerEnablersByGenusType(Type brokerConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
BrokerConstrainerEnablerList
corresponding to
the given broker constrainer enabler genus Type
which
does not include broker constrainer enablers of genus types derived
from the specified Type.
In plenary mode, the returned list contains all known
broker constrainer enablers or an error results. Otherwise, the
returned list may contain only those broker constrainer enablers that
are accessible through this session.
In active mode, broker constrainer enablers are returned that are
currently active. In any status mode, active and inactive broker
constrainer enablers are returned.brokerConstrainerEnablerGenusType
- a broker constrainer enabler
genus type BrokerConstrainerEnabler
listNullArgumentException
-
brokerConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerConstrainerEnablerList getBrokerConstrainerEnablersByParentGenusType(Type brokerConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
BrokerConstrainerEnablerList
corresponding to
the given broker constrainer enabler genus Type
and
include any additional broker constrainer enablers with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
broker constrainer enablers or an error results. Otherwise, the
returned list may contain only those broker constrainer enablers that
are accessible through this session.
In active mode, broker constrainer enablers are returned that are
currently active. In any status mode, active and inactive broker
constrainer enablers are returned.brokerConstrainerEnablerGenusType
- a broker constrainer enabler
genus type BrokerConstrainerEnabler
listNullArgumentException
-
brokerConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerConstrainerEnablerList getBrokerConstrainerEnablersByRecordType(Type brokerConstrainerEnablerRecordType) throws OperationFailedException, PermissionDeniedException
BrokerConstrainerEnablerList
containing the
given broker constrainer enabler record Type.
In plenary mode, the returned list contains all known
broker constrainer enablers or an error results. Otherwise, the
returned list may contain only those broker constrainer enablers that
are accessible through this session.
In active mode, broker constrainer enablers are returned that are
currently active. In any status mode, active and inactive broker
constrainer enablers are returned.brokerConstrainerEnablerRecordType
- a broker constrainer
enabler record type BrokerConstrainerEnabler
listNullArgumentException
-
brokerConstrainerEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerConstrainerEnablerList getBrokerConstrainerEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
BrokerConstrainerEnablerList
effective for the
entire the given date range inclusive but not confisned to the date
range for any agent.
In plenary mode, the returned list contains all known
broker constrainer enablers or an error results. Otherwise, the
returned list may contain only those broker constrainer enablers that
are accessible through this session.
In active mode, broker constrainer enablers are returned that are
currently active in addition to being effective during the given date
range. In any status mode, active and inactive broker constrainer
enablers are returned.from
- a start dateto
- an end date BrokerConstrainerEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerConstrainerEnablerList getBrokerConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
BrokerConstrainerEnablerList
effective for the
entire the given date range inclusive but not confisned to the date
range and evaluated against the given agent.
In plenary mode, the returned list contains all known
broker constrainer enablers or an error results. Otherwise, the
returned list may contain only those broker constrainer enablers that
are accessible through this session.
In active mode, broker constrainer enablers are returned that are
currently active in addition to being effective during the given date
range. In any status mode, active and inactive broker constrainer
enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date BrokerConstrainerEnabler
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. BrokerConstrainerEnablerList getBrokerConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
BrokerConstrainerEnablers.
In plenary mode, the returned list contains all known broker
constrainer enablers or an error results. Otherwise, the returned list
may contain only those broker constrainer enablers that are accessible
through this session.
In active mode, broker constrainer enablers are returned that are
currently active. In any status mode, active and inactive broker
constrainer enablers are returned. BrokerConstrainerEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.