public interface AuctionConstrainerEnablerLookupSession extends OsidSession
This session provides methods for retrieving
AuctionConstrainerEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
AuctionConstrainerEnablers
with the
AuctionConstrainerEnablerAdminSession.
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 |
canLookupAuctionConstrainerEnablers()
Tests if this user can perform
AuctionConstrainerEnablers
lookups. |
AuctionConstrainerEnabler |
getAuctionConstrainerEnabler(Id auctionConstrainerEnablerId)
Gets the
AuctionConstrainerEnabler specified by its
Id. |
AuctionConstrainerEnablerList |
getAuctionConstrainerEnablers()
Gets all
AuctionConstrainerEnablers. |
AuctionConstrainerEnablerList |
getAuctionConstrainerEnablersByGenusType(Type auctionConstrainerEnablerGenusType)
Gets an
AuctionConstrainerEnablerList corresponding to
the given auction constrainer enabler genus Type which
does not include auction constrainer enablers of genus types derived
from the specified Type. |
AuctionConstrainerEnablerList |
getAuctionConstrainerEnablersByIds(IdList auctionConstrainerEnablerIds)
Gets an
AuctionConstrainerEnablerList corresponding to
the given IdList. |
AuctionConstrainerEnablerList |
getAuctionConstrainerEnablersByParentGenusType(Type auctionConstrainerEnablerGenusType)
Gets an
AuctionConstrainerEnablerList corresponding to
the given auction constrainer enabler genus Type and
include any additional auction constrainer enablers with genus types
derived from the specified Type. |
AuctionConstrainerEnablerList |
getAuctionConstrainerEnablersByRecordType(Type auctionConstrainerEnablerRecordType)
Gets an
AuctionConstrainerEnablerList containing the
given auction constrainer enabler record Type. |
AuctionConstrainerEnablerList |
getAuctionConstrainerEnablersOnDate(DateTime from,
DateTime to)
Gets an
AuctionConstrainerEnablerList that are
effective for the entire given date range but not confined to the date
range. |
AuctionConstrainerEnablerList |
getAuctionConstrainerEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets an
AuctionConstrainerEnablerList that are
effective for the entire given date range but not confined to the date
range and evaluated against the given agent. |
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
void |
useActiveAuctionConstrainerEnablerView()
Only active auction constrainer enablers are returned by methods in
this session.
|
void |
useAnyStatusAuctionConstrainerEnablerView()
All active and inactive auction constrainer enablers are returned by
methods in this session.
|
void |
useComparativeAuctionConstrainerEnablerView()
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 |
usePlenaryAuctionConstrainerEnablerView()
A complete view of the
AuctionConstrainerEnabler
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 canLookupAuctionConstrainerEnablers()
AuctionConstrainerEnablers
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 useComparativeAuctionConstrainerEnablerView()
mandatory
- This method is must be implemented. void usePlenaryAuctionConstrainerEnablerView()
AuctionConstrainerEnabler
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 useActiveAuctionConstrainerEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusAuctionConstrainerEnablerView()
mandatory
- This method is must be implemented. AuctionConstrainerEnabler getAuctionConstrainerEnabler(Id auctionConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainerEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
AuctionConstrainerEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to an AuctionConstrainerEnabler
and retained for compatibility.
In active mode, auction constrainer enablers are returned that are
currently active. In any status mode, active and inactive auction
constrainer enablers are returned.auctionConstrainerEnablerId
- Id
of the
AuctionConstrainerEnabler
NotFoundException
- auctionConstrainerEnablerId
not foundNullArgumentException
-
auctionConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. AuctionConstrainerEnablerList getAuctionConstrainerEnablersByIds(IdList auctionConstrainerEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainerEnablerList
corresponding to
the given IdList.
In plenary mode, the returned list contains all of the
auction 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
AuctionConstrainerEnablers
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In active mode, auction constrainer enablers are returned that are
currently active. In any status mode, active and inactive auction
constrainer enablers are returned.auctionConstrainerEnablerIds
- the list of Ids
to
retrieve AuctionConstrainerEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
-
auctionConstrainerEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionConstrainerEnablerList getAuctionConstrainerEnablersByGenusType(Type auctionConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
AuctionConstrainerEnablerList
corresponding to
the given auction constrainer enabler genus Type
which
does not include auction constrainer enablers of genus types derived
from the specified Type.
In plenary mode, the returned list contains all known
auction constrainer enablers or an error results. Otherwise, the
returned list may contain only those auction constrainer enablers that
are accessible through this session.
In active mode, auction constrainer enablers are returned that are
currently active. In any status mode, active and inactive auction
constrainer enablers are returned.auctionConstrainerEnablerGenusType
- an auction constrainer
enabler genus type AuctionConstrainerEnabler
listNullArgumentException
-
auctionConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionConstrainerEnablerList getAuctionConstrainerEnablersByParentGenusType(Type auctionConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
AuctionConstrainerEnablerList
corresponding to
the given auction constrainer enabler genus Type
and
include any additional auction constrainer enablers with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
auction constrainer enablers or an error results. Otherwise, the
returned list may contain only those auction constrainer enablers that
are accessible through this session.
In active mode, auction constrainer enablers are returned that are
currently active. In any status mode, active and inactive auction
constrainer enablers are returned.auctionConstrainerEnablerGenusType
- an auction constrainer
enabler genus type AuctionConstrainerEnabler
listNullArgumentException
-
auctionConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionConstrainerEnablerList getAuctionConstrainerEnablersByRecordType(Type auctionConstrainerEnablerRecordType) throws OperationFailedException, PermissionDeniedException
AuctionConstrainerEnablerList
containing the
given auction constrainer enabler record Type.
In plenary mode, the returned list contains all known
auction constrainer enablers or an error results. Otherwise, the
returned list may contain only those auction constrainer enablers that
are accessible through this session.
In active mode, auction constrainer enablers are returned that are
currently active. In any status mode, active and inactive auction
constrainer enablers are returned.auctionConstrainerEnablerRecordType
- an auction constrainer
enabler record type AuctionConstrainerEnabler
listNullArgumentException
-
auctionConstrainerEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionConstrainerEnablerList getAuctionConstrainerEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AuctionConstrainerEnablerList
that are
effective for the entire given date range but not confined to the date
range.
In plenary mode, the returned list contains all known
auction constrainer enablers or an error results. Otherwise, the
returned list may contain only those auction constrainer enablers that
are accessible through this session.
In active mode, auction 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 auction constrainer
enablers are returned.from
- a start dateto
- an end date AuctionConstrainerEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionConstrainerEnablerList getAuctionConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
AuctionConstrainerEnablerList
that are
effective for 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 constrainer enablers or an error results. Otherwise, the
returned list may contain only those auction constrainer enablers that
are accessible through this session.
In active mode, auction 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 auction constrainer
enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date AuctionConstrainerEnabler
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. AuctionConstrainerEnablerList getAuctionConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
AuctionConstrainerEnablers.
In plenary mode, the returned list contains all known auction
constrainer enablers or an error results. Otherwise, the returned list
may contain only those auction constrainer enablers that are
accessible through this session.
In active mode, auction constrainer enablers are returned that are
currently active. In any status mode, active and inactive auction
constrainer enablers are returned. AuctionConstrainerEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.