public interface OfferingConstrainerEnablerAdminSession extends OsidSession
This session creates and removes offering constrainer enablers. The
data for create and update is provided via the
OfferingConstrainerEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasOfferingConstrainerEnabler(Id offeringConstrainerEnablerId,
Id aliasId)
Adds an
Id to an OfferingConstrainerEnabler
for the purpose of creating compatibility. |
boolean |
canCreateOfferingConstrainerEnabler()
Tests if this user can create offering constrainer enablers.
|
boolean |
canCreateOfferingConstrainerEnablerWithRecordTypes(Type[] offeringConstrainerEnablerRecordTypes)
Tests if this user can create a single
OfferingConstrainerEnabler using the desired record types. |
boolean |
canDeleteOfferingConstrainerEnablers()
Tests if this user can delete offering constrainer enablers.
|
boolean |
canManageOfferingConstrainerEnablerAliases()
Tests if this user can manage
Id aliases for offering
constrainer enablers. |
boolean |
canUpdateOfferingConstrainerEnablers()
Tests if this user can update offering constrainer enablers.
|
OfferingConstrainerEnabler |
createOfferingConstrainerEnabler(OfferingConstrainerEnablerForm offeringConstrainerEnablerForm)
Creates a new
OfferingConstrainerEnabler. |
void |
deleteOfferingConstrainerEnabler(Id offeringConstrainerEnablerId)
Deletes an
OfferingConstrainerEnabler. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
OfferingConstrainerEnablerForm |
getOfferingConstrainerEnablerFormForCreate(Type[] offeringConstrainerEnablerRecordTypes)
Gets the offering constrainer enabler form for creating new offering
constrainer enablers.
|
OfferingConstrainerEnablerForm |
getOfferingConstrainerEnablerFormForUpdate(Id offeringConstrainerEnablerId)
Gets the offering constrainer enabler form for updating an existing
offering constrainer enabler.
|
void |
updateOfferingConstrainerEnabler(OfferingConstrainerEnablerForm offeringConstrainerEnablerForm)
Updates an existing offering constrainer enabler.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogueId()
Catalogue
Id
associated with
this session. Catalogue Id
associated with this sessionmandatory
- This method must be implemented. Catalogue getCatalogue() throws OperationFailedException, PermissionDeniedException
Catalogue
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateOfferingConstrainerEnabler()
OfferingConstrainerEnabler
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 OfferingConstrainerEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateOfferingConstrainerEnablerWithRecordTypes(Type[] offeringConstrainerEnablerRecordTypes)
OfferingConstrainerEnabler
using the desired record types.
While
OfferingRulesManager.getOfferingConstrainerEnablerRecordTypes()
can be used to examine which records are supported, this
method tests which record(s) are required for creating a specific
OfferingConstrainerEnabler.
Providing an empty array
tests if an OfferingConstrainerEnabler
can be created
with no records.offeringConstrainerEnablerRecordTypes
- array of offering
constrainer enabler record types true
if OfferingConstrainerEnabler
creation using the specified record Types
is supported, false
otherwiseNullArgumentException
-
offeringConstrainerEnablerRecordTypes
is null
mandatory
- This method must be implemented. OfferingConstrainerEnablerForm getOfferingConstrainerEnablerFormForCreate(Type[] offeringConstrainerEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
offeringConstrainerEnablerRecordTypes
- array of offering
constrainer enabler record typesNullArgumentException
-
offeringConstrainerEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. OfferingConstrainerEnabler createOfferingConstrainerEnabler(OfferingConstrainerEnablerForm offeringConstrainerEnablerForm) throws OperationFailedException, PermissionDeniedException
OfferingConstrainerEnabler.
offeringConstrainerEnablerForm
- the form for this
OfferingConstrainerEnabler
OfferingConstrainerEnabler
IllegalStateException
-
offeringConstrainerEnablerForm
already used in a
create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
-
offeringConstrainerEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
offeringConstrainerEnablerForm did not originate from
getOfferingConstrainerEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateOfferingConstrainerEnablers()
OfferingConstrainerEnabler
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 OfferingConstrainerEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. OfferingConstrainerEnablerForm getOfferingConstrainerEnablerFormForUpdate(Id offeringConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
offeringConstrainerEnablerId
- the Id
of the
OfferingConstrainerEnabler
NotFoundException
- offeringConstrainerEnablerId
is not foundNullArgumentException
-
offeringConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateOfferingConstrainerEnabler(OfferingConstrainerEnablerForm offeringConstrainerEnablerForm) throws OperationFailedException, PermissionDeniedException
offeringConstrainerEnablerForm
- the form containing the
elements to be updatedIllegalStateException
-
offeringConstrainerEnablerForm
already used in an
update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
-
offeringConstrainerEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
offeringConstrainerEnablerForm
did not originate from
getOfferingConstrainerEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteOfferingConstrainerEnablers()
OfferingConstrainerEnabler
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 OfferingConstrainerEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteOfferingConstrainerEnabler(Id offeringConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainerEnabler.
offeringConstrainerEnablerId
- the Id
of the
OfferingConstrainerEnabler
to removeNotFoundException
- offeringConstrainerEnablerId
not foundNullArgumentException
-
offeringConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageOfferingConstrainerEnablerAliases()
Id
aliases for offering
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 OfferingConstrainerEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasOfferingConstrainerEnabler(Id offeringConstrainerEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to an OfferingConstrainerEnabler
for the purpose of creating compatibility. The primary
Id
of the OfferingConstrainerEnabler
is
determined by the provider. The new Id
performs as an
alias to the primary Id
. If the alias is a pointer to
another offering constrainer enabler. it is reassigned to the given
offering constrainer enabler Id.
offeringConstrainerEnablerId
- the Id
of an
OfferingConstrainerEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- offeringConstrainerEnablerId
not foundNullArgumentException
-
offeringConstrainerEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.