public interface AuctionProcessorEnablerAdminSession extends OsidSession
This session creates and removes auction processor enablers. The data
for create and update is provided via the
AuctionProcessorEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasAuctionProcessorEnabler(Id auctionProcessorEnablerId,
Id aliasId)
Adds an
Id to an AuctionProcessorEnabler
for the purpose of creating compatibility. |
boolean |
canCreateAuctionProcessorEnabler()
Tests if this user can create auction processor enablers.
|
boolean |
canCreateAuctionProcessorEnablerWithRecordTypes(Type[] auctionProcessorEnablerRecordTypes)
Tests if this user can create a single
AuctionProcessorEnabler
using the desired record types. |
boolean |
canDeleteAuctionProcessorEnablers()
Tests if this user can delete auction processor enablers.
|
boolean |
canManageAuctionProcessorEnablerAliases()
Tests if this user can manage
Id aliases for auction
processor enablers. |
boolean |
canUpdateAuctionProcessorEnablers()
Tests if this user can update auction processor enablers.
|
AuctionProcessorEnabler |
createAuctionProcessorEnabler(AuctionProcessorEnablerForm auctionProcessorEnablerForm)
Creates a new
AuctionProcessorEnabler. |
void |
deleteAuctionProcessorEnabler(Id auctionProcessorEnablerId)
Deletes an
AuctionProcessorEnabler. |
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
AuctionProcessorEnablerForm |
getAuctionProcessorEnablerFormForCreate(Type[] auctionProcessorEnablerRecordTypes)
Gets the auction processor enabler form for creating new auction
processor enablers.
|
AuctionProcessorEnablerForm |
getAuctionProcessorEnablerFormForUpdate(Id auctionProcessorEnablerId)
Gets the auction processor enabler form for updating an existing
auction processor enabler.
|
void |
updateAuctionProcessorEnabler(AuctionProcessorEnablerForm auctionProcessorEnablerForm)
Updates an existing auction processor enabler.
|
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 canCreateAuctionProcessorEnabler()
AuctionProcessorEnabler
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 AuctionProcessorEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateAuctionProcessorEnablerWithRecordTypes(Type[] auctionProcessorEnablerRecordTypes)
AuctionProcessorEnabler
using the desired record types. While
BiddingRulesManager.getAuctionProcessorEnablerRecordTypes()
can be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
AuctionProcessorEnabler.
Providing an empty array tests if an
AuctionProcessorEnabler
can be created with no records.auctionProcessorEnablerRecordTypes
- array of auction processor
enabler record types true
if AuctionProcessorEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
auctionProcessorEnablerRecordTypes
is null
mandatory
- This method must be implemented. AuctionProcessorEnablerForm getAuctionProcessorEnablerFormForCreate(Type[] auctionProcessorEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
auctionProcessorEnablerRecordTypes
- array of auction processor
enabler record typesNullArgumentException
-
auctionProcessorEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. AuctionProcessorEnabler createAuctionProcessorEnabler(AuctionProcessorEnablerForm auctionProcessorEnablerForm) throws OperationFailedException, PermissionDeniedException
AuctionProcessorEnabler.
auctionProcessorEnablerForm
- the form for this
AuctionProcessorEnabler
AuctionProcessorEnabler
IllegalStateException
-
auctionProcessorEnablerForm
already used in a create
transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
-
auctionProcessorEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
auctionProcessorEnablerForm did not originate from
getAuctionProcessorEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateAuctionProcessorEnablers()
AuctionProcessorEnabler
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 AuctionProcessorEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. AuctionProcessorEnablerForm getAuctionProcessorEnablerFormForUpdate(Id auctionProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionProcessorEnablerId
- the Id
of the
AuctionProcessorEnabler
NotFoundException
- auctionProcessorEnablerId
is not foundNullArgumentException
-
auctionProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateAuctionProcessorEnabler(AuctionProcessorEnablerForm auctionProcessorEnablerForm) throws OperationFailedException, PermissionDeniedException
auctionProcessorEnablerForm
- the form containing the elements
to be updatedIllegalStateException
-
auctionProcessorEnablerForm
already used in an update
transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
-
auctionProcessorEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
auctionProcessorEnablerForm did not originate from
getAuctionProcessorEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteAuctionProcessorEnablers()
AuctionProcessorEnabler
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 AuctionProcessorEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteAuctionProcessorEnabler(Id auctionProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessorEnabler.
auctionProcessorEnablerId
- the Id
of the
AuctionProcessorEnabler
to removeNotFoundException
- auctionProcessorEnablerId
not foundNullArgumentException
-
auctionProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageAuctionProcessorEnablerAliases()
Id
aliases for auction
processor enablers. 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 AuctionProcessorEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasAuctionProcessorEnabler(Id auctionProcessorEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to an AuctionProcessorEnabler
for the purpose of creating compatibility. The primary Id
of the AuctionProcessorEnabler
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 enabler. it is reassigned to the given auction
processor enabler Id.
auctionProcessorEnablerId
- the Id
of an
AuctionProcessorEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- auctionProcessorEnablerId
not foundNullArgumentException
-
auctionProcessorEnablerId
or aliasId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.