public interface AuctionProcessorAdminSession extends OsidSession
This session creates and removes auction processors. The data for
create and update is provided via the AuctionProcessorForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasAuctionProcessor(Id auctionProcessorId,
Id aliasId)
Adds an
Id to an AuctionProcessor for
the purpose of creating compatibility. |
boolean |
canCreateAuctionProcessor()
Tests if this user can create auction processors.
|
boolean |
canCreateAuctionProcessorWithRecordTypes(Type[] auctionProcessorRecordTypes)
Tests if this user can create a single
AuctionProcessor
using the desired record types. |
boolean |
canDeleteAuctionProcessors()
Tests if this user can delete auction processors.
|
boolean |
canManageAuctionProcessorAliases()
Tests if this user can manage
Id aliases for auction
processors. |
boolean |
canUpdateAuctionProcessors()
Tests if this user can update auction processors.
|
AuctionProcessor |
createAuctionProcessor(AuctionProcessorForm auctionProcessorForm)
Creates a new
AuctionProcessor. |
void |
deleteAuctionProcessor(Id auctionProcessorId)
Deletes an
AuctionProcessor. |
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
AuctionProcessorForm |
getAuctionProcessorFormForCreate(Type[] auctionProcessorRecordTypes)
Gets the auction processor form for creating new auction processors.
|
AuctionProcessorForm |
getAuctionProcessorFormForUpdate(Id auctionProcessorId)
Gets the auction processor form for updating an existing auction
processor.
|
void |
updateAuctionProcessor(AuctionProcessorForm auctionProcessorForm)
Updates an existing auction processor.
|
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 canCreateAuctionProcessor()
AuctionProcessor
will result in a PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer create operations
to an unauthorized user. false
if AuctionProcessor
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateAuctionProcessorWithRecordTypes(Type[] auctionProcessorRecordTypes)
AuctionProcessor
using the desired record types. While
BiddingRulesManager.getAuctionProcessorRecordTypes()
can be
used to examine which records are supported, this method tests which
record(s) are required for creating a specific
AuctionProcessor.
Providing an empty array tests if an
AuctionProcessor
can be created with no records.auctionProcessorRecordTypes
- array of auction processor record
types true
if AuctionProcessor
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
auctionProcessorRecordTypes
is null
mandatory
- This method must be implemented. AuctionProcessorForm getAuctionProcessorFormForCreate(Type[] auctionProcessorRecordTypes) throws OperationFailedException, PermissionDeniedException
auctionProcessorRecordTypes
- array of auction processor record
typesNullArgumentException
-
auctionProcessorRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. AuctionProcessor createAuctionProcessor(AuctionProcessorForm auctionProcessorForm) throws OperationFailedException, PermissionDeniedException
AuctionProcessor.
auctionProcessorForm
- the form for this AuctionProcessor
AuctionProcessor
IllegalStateException
- auctionProcessorForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- auctionProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auctionProcessorForm did
not originate from getAuctionProcessorFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateAuctionProcessors()
AuctionProcessor
will result in a PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer update operations
to an unauthorized user. false
if AuctionProcessor
modification is not authorized, true
otherwisemandatory
- This method must be implemented. AuctionProcessorForm getAuctionProcessorFormForUpdate(Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionProcessorId
- the Id
of the
AuctionProcessor
NotFoundException
- auctionProcessorId
is not foundNullArgumentException
- auctionProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateAuctionProcessor(AuctionProcessorForm auctionProcessorForm) throws OperationFailedException, PermissionDeniedException
auctionProcessorForm
- the form containing the elements to be
updatedIllegalStateException
- auctionProcessorForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- auctionProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auctionProcessorForm did
not originate from getAuctionProcessorFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteAuctionProcessors()
AuctionProcessor
will result in a PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer delete operations
to an unauthorized user. false
if AuctionProcessor
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteAuctionProcessor(Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessor.
auctionProcessorId
- the Id
of the
AuctionProcessor
to removeNotFoundException
- auctionProcessorId
not foundNullArgumentException
- auctionProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageAuctionProcessorAliases()
Id
aliases for auction
processors. A return of true does not guarantee successful
authorization. A return of false indicates that it is known changing
an alias will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer alias
operations to an unauthorized user. false
if AuctionProcessor
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasAuctionProcessor(Id auctionProcessorId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to an AuctionProcessor
for
the purpose of creating compatibility. The primary Id
of the AuctionProcessor
is determined by the provider.
The new Id
performs as an alias to the primary
Id
. If the alias is a pointer to another auction processor.
it is reassigned to the given auction processor Id.
auctionProcessorId
- the Id
of an
AuctionProcessor
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- auctionProcessorId
not foundNullArgumentException
- auctionProcessorId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.