public interface AuctionConstrainerAdminSession extends OsidSession
This session creates and removes auction constrainers. The data for
create and update is provided via the AuctionConstrainerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasAuctionConstrainer(Id auctionConstrainerId,
Id aliasId)
Adds an
Id to an AuctionConstrainer for
the purpose of creating compatibility. |
boolean |
canCreateAuctionConstrainer()
Tests if this user can create auction constrainers.
|
boolean |
canCreateAuctionConstrainerWithRecordTypes(Type[] auctionConstrainerRecordTypes)
BiddingRulesManager.getAuctionConstrainerRecordTypes()
can be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
AuctionConstrainer. |
boolean |
canDeleteAuctionConstrainers()
Tests if this user can delete auction constrainers.
|
boolean |
canManageAuctionConstrainerAliases()
Tests if this user can manage
Id aliases for auction
constrainers. |
boolean |
canUpdateAuctionConstrainers()
Tests if this user can update auction constrainers.
|
AuctionConstrainer |
createAuctionConstrainer(AuctionConstrainerForm auctionConstrainerForm)
Creates a new
AuctionConstrainer. |
void |
deleteAuctionConstrainer(Id auctionConstrainerId)
Deletes an
AuctionConstrainer. |
AuctionConstrainerForm |
getAuctionConstrainerFormForCreate(Type[] auctionConstrainerRecordTypes)
Gets the auction constrainer form for creating new auction
constrainers.
|
AuctionConstrainerForm |
getAuctionConstrainerFormForUpdate(Id auctionConstrainerId)
Gets the auction constrainer form for updating an existing auction
constrainer.
|
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
void |
updateAuctionConstrainer(AuctionConstrainerForm auctionConstrainerForm)
Updates an existing auction constrainer.
|
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 canCreateAuctionConstrainer()
AuctionConstrainer
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 AuctionConstrainer
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateAuctionConstrainerWithRecordTypes(Type[] auctionConstrainerRecordTypes)
BiddingRulesManager.getAuctionConstrainerRecordTypes()
can be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
AuctionConstrainer.
Providing an empty array tests if an
AuctionConstrainer
can be created with no records.auctionConstrainerRecordTypes
- array of auction constrainer
record types true
if AuctionConstrainer
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
auctionConstrainerRecordTypes
is null
mandatory
- This method must be implemented. AuctionConstrainerForm getAuctionConstrainerFormForCreate(Type[] auctionConstrainerRecordTypes) throws OperationFailedException, PermissionDeniedException
auctionConstrainerRecordTypes
- array of auction constrainer
record typesNullArgumentException
-
auctionConstrainerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. AuctionConstrainer createAuctionConstrainer(AuctionConstrainerForm auctionConstrainerForm) throws OperationFailedException, PermissionDeniedException
AuctionConstrainer.
auctionConstrainerForm
- the form for this
AuctionConstrainer
AuctionConstrainer
IllegalStateException
- auctionConstrainerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- auctionConstrainerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auctionConstrainerForm
did not originate from
getAuctionConstrainerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateAuctionConstrainers()
AuctionConstrainer
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 AuctionConstrainer
modification is not authorized, true
otherwisemandatory
- This method must be implemented. AuctionConstrainerForm getAuctionConstrainerFormForUpdate(Id auctionConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionConstrainerId
- the Id
of the
AuctionConstrainer
NotFoundException
- auctionConstrainerId
is not foundNullArgumentException
- auctionConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateAuctionConstrainer(AuctionConstrainerForm auctionConstrainerForm) throws OperationFailedException, PermissionDeniedException
auctionConstrainerForm
- the form containing the elements to be
updatedIllegalStateException
- auctionConstrainerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- auctionConstrainerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auctionConstrainerForm
did not originate from
getAuctionConstrainerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteAuctionConstrainers()
AuctionConstrainer
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 AuctionConstrainer
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteAuctionConstrainer(Id auctionConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainer.
auctionConstrainerId
- the Id
of the
AuctionConstrainer
to removeNotFoundException
- auctionConstrainerId
not foundNullArgumentException
- auctionConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageAuctionConstrainerAliases()
Id
aliases for auction
constrainers. 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 AuctionConstrainer
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasAuctionConstrainer(Id auctionConstrainerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to an AuctionConstrainer
for
the purpose of creating compatibility. The primary Id
of the AuctionConstrainer
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 constrainer. it is reassigned to the given auction constrainer
Id.
auctionConstrainerId
- the Id
of an
AuctionConstrainer
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- auctionConstrainerId
not foundNullArgumentException
- auctionConstrainerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.