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