public interface PriceEnablerAdminSession extends OsidSession
This session creates and removes price enablers. The data for create
and update is provided via the PriceEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasPriceEnabler(Id priceEnablerId,
Id aliasId)
Adds an
Id to a PriceEnabler for the
purpose of creating compatibility. |
boolean |
canCreatePriceEnabler()
Tests if this user can create price enablers.
|
boolean |
canCreatePriceEnablerWithRecordTypes(Type[] priceEnablerRecordTypes)
Tests if this user can create a single
PriceEnabler
using the desired record types. |
boolean |
canDeletePriceEnablers()
Tests if this user can delete price enablers.
|
boolean |
canManagePriceEnablerAliases()
Tests if this user can manage
Id aliases for price
enablers. |
boolean |
canUpdatePriceEnablers()
Tests if this user can update price enablers.
|
PriceEnabler |
createPriceEnabler(PriceEnablerForm priceEnablerForm)
Creates a new
PriceEnabler. |
void |
deletePriceEnabler(Id priceEnablerId)
Deletes a
PriceEnabler. |
PriceEnablerForm |
getPriceEnablerFormForCreate(Type[] priceEnablerRecordTypes)
Gets the price enabler form for creating new price enablers.
|
PriceEnablerForm |
getPriceEnablerFormForUpdate(Id priceEnablerId)
Gets the price enabler form for updating an existing price enabler.
|
Store |
getStore()
Gets the
Store associated with this session. |
Id |
getStoreId()
Gets the
Store Id associated with this
session. |
void |
updatePriceEnabler(PriceEnablerForm priceEnablerForm)
Updates an existing price enabler.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getStoreId()
Store
Id
associated with this
session. Store Id
associated with this sessionmandatory
- This method must be implemented. Store getStore() throws OperationFailedException, PermissionDeniedException
Store
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreatePriceEnabler()
PriceEnabler
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 PriceEnabler
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreatePriceEnablerWithRecordTypes(Type[] priceEnablerRecordTypes)
PriceEnabler
using the desired record types. While
OrderingRulesManager.getPriceEnablerRecordTypes()
can be used
to examine which records are supported, this method tests which
record(s) are required for creating a specific PriceEnabler.
Providing an empty array tests if a PriceEnabler
can be created with no records.priceEnablerRecordTypes
- array of price enabler record types true
if PriceEnabler
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
- priceEnablerRecordTypes
is null
mandatory
- This method must be implemented. PriceEnablerForm getPriceEnablerFormForCreate(Type[] priceEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
priceEnablerRecordTypes
- array of price enabler record typesNullArgumentException
- priceEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. PriceEnabler createPriceEnabler(PriceEnablerForm priceEnablerForm) throws OperationFailedException, PermissionDeniedException
PriceEnabler.
priceEnablerForm
- the form for this PriceEnabler
PriceEnabler
IllegalStateException
- priceEnablerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- priceEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- priceEnablerForm
did not originate from getPriceEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdatePriceEnablers()
PriceEnabler
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 PriceEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. PriceEnablerForm getPriceEnablerFormForUpdate(Id priceEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
priceEnablerId
- the Id
of the
PriceEnabler
NotFoundException
- priceEnablerId
is
not foundNullArgumentException
- priceEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updatePriceEnabler(PriceEnablerForm priceEnablerForm) throws OperationFailedException, PermissionDeniedException
priceEnablerForm
- the form containing the elements to be
updatedIllegalStateException
- priceEnablerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- priceEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- priceEnablerForm
did not originate from getPriceEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeletePriceEnablers()
PriceEnabler
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 PriceEnabler
deletion
is not authorized, true
otherwisemandatory
- This method must be implemented. void deletePriceEnabler(Id priceEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PriceEnabler.
priceEnablerId
- the Id
of the
PriceEnabler
to removeNotFoundException
- priceEnablerId
not
foundNullArgumentException
- priceEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManagePriceEnablerAliases()
Id
aliases for price
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 PriceEnabler
aliasing
is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasPriceEnabler(Id priceEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a PriceEnabler
for the
purpose of creating compatibility. The primary Id
of
the PriceEnabler
is determined by the provider. The new
Id
performs as an alias to the primary Id
. If the alias is a pointer to another price enabler. it is
reassigned to the given price enabler Id.
priceEnablerId
- the Id
of a PriceEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- priceEnablerId
not
foundNullArgumentException
- priceEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.