public interface AuctionProcessorEnablerLookupSession extends OsidSession
This session provides methods for retrieving
AuctionProcessorEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
AuctionProcessorEnablers
with the
AuctionProcessorEnablerAdminSession.
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 |
canLookupAuctionProcessorEnablers()
Tests if this user can perform
AuctionProcessorEnablers
lookups. |
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
AuctionProcessorEnabler |
getAuctionProcessorEnabler(Id auctionProcessorEnablerId)
Gets the
AuctionProcessorEnabler specified by its
Id. |
AuctionProcessorEnablerList |
getAuctionProcessorEnablers()
Gets all
AuctionProcessorEnablers. |
AuctionProcessorEnablerList |
getAuctionProcessorEnablersByGenusType(Type auctionProcessorEnablerGenusType)
Gets an
AuctionProcessorEnablerList corresponding to
the given auction processor enabler genus Type which
does not include auction processor enablers of genus types derived
from the specified Type. |
AuctionProcessorEnablerList |
getAuctionProcessorEnablersByIds(IdList auctionProcessorEnablerIds)
Gets an
AuctionProcessorEnablerList corresponding to
the given IdList. |
AuctionProcessorEnablerList |
getAuctionProcessorEnablersByParentGenusType(Type auctionProcessorEnablerGenusType)
Gets an
AuctionProcessorEnablerList corresponding to
the given auction processor enabler genus Type and
include any additional auction processor enablers with genus types
derived from the specified Type. |
AuctionProcessorEnablerList |
getAuctionProcessorEnablersByRecordType(Type auctionProcessorEnablerRecordType)
Gets an
AuctionProcessorEnablerList containing the
given auction processor enabler record Type. |
AuctionProcessorEnablerList |
getAuctionProcessorEnablersOnDate(DateTime from,
DateTime to)
Gets an
AuctionProcessorEnablerList effective within
the given date range. |
AuctionProcessorEnablerList |
getAuctionProcessorEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets an
AuctionProcessorEnablerList effective during
the entire given date range but not confined to the date range and
evaluated against the given agent. |
void |
useActiveAuctionProcessorEnablerView()
Only active auction processor enablers are returned by methods in this
session.
|
void |
useAnyStatusAuctionProcessorEnablerView()
All active and inactive auction processor enablers are returned by
methods in this session.
|
void |
useComparativeAuctionProcessorEnablerView()
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 |
useFederatedAuctionHouseView()
Federates the view for methods in this session.
|
void |
useIsolatedAuctionHouseView()
Isolates the view for methods in this session.
|
void |
usePlenaryAuctionProcessorEnablerView()
A complete view of the
AuctionProcessorEnabler returns
is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAuctionHouseId()
AuctionHouse
Id
associated with
this session. AuctionHouse Id
associated with this
sessionmandatory
- This method must be implemented. AuctionHouse getAuctionHouse() throws OperationFailedException, PermissionDeniedException
AuctionHouse
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupAuctionProcessorEnablers()
AuctionProcessorEnablers
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 useComparativeAuctionProcessorEnablerView()
mandatory
- This method is must be implemented. void usePlenaryAuctionProcessorEnablerView()
AuctionProcessorEnabler
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 useFederatedAuctionHouseView()
mandatory
- This method is must be implemented. void useIsolatedAuctionHouseView()
mandatory
- This method is must be implemented. void useActiveAuctionProcessorEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusAuctionProcessorEnablerView()
mandatory
- This method is must be implemented. AuctionProcessorEnabler getAuctionProcessorEnabler(Id auctionProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessorEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
AuctionProcessorEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to an AuctionProcessorEnabler
and retained
for compatibility.
In active mode, auction processor enablers are returned that are
currently active. In any status mode, active and inactive auction
processor enablers are returned.auctionProcessorEnablerId
- Id
of the
AuctionProcessorEnabler
NotFoundException
- auctionProcessorEnablerId
not foundNullArgumentException
-
auctionProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. AuctionProcessorEnablerList getAuctionProcessorEnablersByIds(IdList auctionProcessorEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessorEnablerList
corresponding to
the given IdList.
In plenary mode, the returned list contains all of the
auction processor 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 AuctionProcessorEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, auction processor enablers are returned that are
currently active. In any status mode, active and inactive auction
processor enablers are returned.auctionProcessorEnablerIds
- the list of Ids
to
retrieve AuctionProcessorEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
-
auctionProcessorEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionProcessorEnablerList getAuctionProcessorEnablersByGenusType(Type auctionProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
AuctionProcessorEnablerList
corresponding to
the given auction processor enabler genus Type
which
does not include auction processor enablers of genus types derived
from the specified Type.
In plenary mode, the returned list contains all known
auction processor enablers or an error results. Otherwise, the
returned list may contain only those auction processor enablers that
are accessible through this session.
In active mode, auction processor enablers are returned that are
currently active. In any status mode, active and inactive auction
processor enablers are returned.auctionProcessorEnablerGenusType
- an auction processor enabler
genus type AuctionProcessorEnabler
listNullArgumentException
-
auctionProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionProcessorEnablerList getAuctionProcessorEnablersByParentGenusType(Type auctionProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
AuctionProcessorEnablerList
corresponding to
the given auction processor enabler genus Type
and
include any additional auction processor enablers with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
auction processor enablers or an error results. Otherwise, the
returned list may contain only those auction processor enablers that
are accessible through this session.
In active mode, auction processor enablers are returned that are
currently active. In any status mode, active and inactive auction
processor enablers are returned.auctionProcessorEnablerGenusType
- an auction processor enabler
genus type AuctionProcessorEnabler
listNullArgumentException
-
auctionProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionProcessorEnablerList getAuctionProcessorEnablersByRecordType(Type auctionProcessorEnablerRecordType) throws OperationFailedException, PermissionDeniedException
AuctionProcessorEnablerList
containing the
given auction processor enabler record Type.
In plenary mode, the returned list contains all known
auction processor enablers or an error results. Otherwise, the
returned list may contain only those auction processor enablers that
are accessible through this session.
In active mode, auction processor enablers are returned that are
currently active. In any status mode, active and inactive auction
processor enablers are returned.auctionProcessorEnablerRecordType
- an auction processor enabler
record type AuctionProcessorEnabler
listNullArgumentException
-
auctionProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionProcessorEnablerList getAuctionProcessorEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AuctionProcessorEnablerList
effective within
the given date range.
In plenary mode, the returned list contains all known
auction processor enablers or an error results. Otherwise, the
returned list may contain only those auction processor enablers that
are accessible through this session.
In active mode, auction processor enablers are returned that are
currently active. In any status mode, active and inactive auction
processor enablers are returned.from
- a start dateto
- an end date AuctionProcessorEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionProcessorEnablerList getAuctionProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AuctionProcessorEnablerList
effective during
the entire given date range but not confined to the date range and
evaluated against the given agent.
In plenary mode, the returned list contains all known
auction processor enablers or an error results. Otherwise, the
returned list may contain only those auction processor enablers that
are accessible through this session.
In active mode, auction processor enablers are returned that are
currently active. In any status mode, active and inactive auction
processor enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date AuctionProcessorEnabler
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. AuctionProcessorEnablerList getAuctionProcessorEnablers() throws OperationFailedException, PermissionDeniedException
AuctionProcessorEnablers.
In plenary mode, the returned list contains all known auction
processor enablers or an error results. Otherwise, the returned list
may contain only those auction processor enablers that are accessible
through this session.
In active mode, auction processor enablers are returned that are
currently active. In any status mode, active and inactive auction
processor enablers are returned. AuctionProcessorEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.