public interface AuctionConstrainerLookupSession extends OsidSession
This session provides methods for retrieving
AuctionConstrainers.
This session defines views that offer differing behaviors when retrieving multiple objects.
AuctionConstrainers
with
the AuctionConstrainerAdminSession.
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 |
canLookupAuctionConstrainers()
Tests if this user can perform
AuctionConstrainers
lookups. |
AuctionConstrainer |
getAuctionConstrainer(Id auctionConstrainerId)
Gets the
AuctionConstrainer specified by its Id. |
AuctionConstrainerList |
getAuctionConstrainers()
Gets all
AuctionConstrainers. |
AuctionConstrainerList |
getAuctionConstrainersByGenusType(Type auctionConstrainerGenusType)
Gets an
AuctionConstrainerList corresponding to the
given auction constrainer genus Type which does not
include auction constrainer of genus types derived from the specified
Type. |
AuctionConstrainerList |
getAuctionConstrainersByIds(IdList auctionConstrainerIds)
Gets an
AuctionConstrainerList corresponding to the
given IdList. |
AuctionConstrainerList |
getAuctionConstrainersByParentGenusType(Type auctionConstrainerGenusType)
Gets an
AuctionConstrainerList corresponding to the
given auction constrainer genus Type and include any
additional auction constrainer with genus types derived from the
specified Type. |
AuctionConstrainerList |
getAuctionConstrainersByRecordType(Type auctionConstrainerRecordType)
Gets an
AuctionConstrainerList containing the given
auction constrainer record Type. |
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
void |
useActiveAuctionConstrainerView()
Only active auction constrainers are returned by methods in this
session.
|
void |
useAnyStatusAuctionConstrainerView()
All active and inactive auction constrainers are returned by methods
in this session.
|
void |
useComparativeAuctionConstrainerView()
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 |
usePlenaryAuctionConstrainerView()
A complete view of the
AuctionConstrainer 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 canLookupAuctionConstrainers()
AuctionConstrainers
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 useComparativeAuctionConstrainerView()
mandatory
- This method is must be implemented. void usePlenaryAuctionConstrainerView()
AuctionConstrainer
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 useActiveAuctionConstrainerView()
mandatory
- This method is must be implemented. void useAnyStatusAuctionConstrainerView()
mandatory
- This method is must be implemented. AuctionConstrainer getAuctionConstrainer(Id auctionConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainer
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
AuctionConstrainer
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an AuctionConstrainer
and retained for
compatibility.
In active mode, auction constrainers are returned that are currently
active. In any status mode, active and inactive auction constrainers
are returned.auctionConstrainerId
- Id
of the
AuctionConstrainer
NotFoundException
- auctionConstrainerId
not foundNullArgumentException
- auctionConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. AuctionConstrainerList getAuctionConstrainersByIds(IdList auctionConstrainerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
auction constrainer 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 AuctionConstrainers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, auction constrainers are returned that are currently
active. In any status mode, active and inactive auction constrainers
are returned.auctionConstrainerIds
- the list of Ids
to
retrieve AuctionConstrainer
listNotFoundException
- an Id was
not foundNullArgumentException
- auctionConstrainerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionConstrainerList getAuctionConstrainersByGenusType(Type auctionConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
AuctionConstrainerList
corresponding to the
given auction constrainer genus Type
which does not
include auction constrainer of genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
auction constrainer or an error results. Otherwise, the returned list
may contain only those auction constrainer that are accessible through
this session.
In active mode, auction constrainers are returned that are currently
active. In any status mode, active and inactive auction constrainers
are returned.auctionConstrainerGenusType
- an auction constrainer genus type AuctionConstrainer
listNullArgumentException
-
auctionConstrainerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionConstrainerList getAuctionConstrainersByParentGenusType(Type auctionConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
AuctionConstrainerList
corresponding to the
given auction constrainer genus Type
and include any
additional auction constrainer with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
auction constrainer or an error results. Otherwise, the returned list
may contain only those auction constrainer that are accessible through
this session.
In active mode, auction constrainers are returned that are currently
active. In any status mode, active and inactive auction constrainers
are returned.auctionConstrainerGenusType
- an auction constrainer genus type AuctionConstrainer
listNullArgumentException
-
auctionConstrainerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionConstrainerList getAuctionConstrainersByRecordType(Type auctionConstrainerRecordType) throws OperationFailedException, PermissionDeniedException
AuctionConstrainerList
containing the given
auction constrainer record Type.
In plenary mode, the returned list contains all known
auction constrainer or an error results. Otherwise, the returned list
may contain only those auction constrainer that are accessible through
this session.
In active mode, auction constrainers are returned that are currently
active. In any status mode, active and inactive auction constrainers
are returned.auctionConstrainerRecordType
- an auction constrainer record
type AuctionConstrainer
listNullArgumentException
-
auctionConstrainerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionConstrainerList getAuctionConstrainers() throws OperationFailedException, PermissionDeniedException
AuctionConstrainers.
In plenary mode, the returned list contains all known auction
constrainer or an error results. Otherwise, the returned list may
contain only those auction constrainer that are accessible through
this session.
In active mode, auction constrainers are returned that are currently
active. In any status mode, active and inactive auction constrainers
are returned. AuctionConstrainer
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.