public interface OfferingConstrainerAdminSession extends OsidSession
This session creates and removes offering constrainers. The data for
create and update is provided via the OfferingConstrainerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasOfferingConstrainer(Id offeringConstrainerId,
Id aliasId)
Adds an
Id to an OfferingConstrainer for
the purpose of creating compatibility. |
boolean |
canCreateOfferingConstrainer()
Tests if this user can create offering constrainers.
|
boolean |
canCreateOfferingConstrainerWithRecordTypes(Type[] offeringConstrainerRecordTypes)
OfferingRulesManager.getOfferingConstrainerRecordTypes()
can be used to examine which records are supported, this
method tests which record(s) are required for creating a specific
OfferingConstrainer. |
boolean |
canDeleteOfferingConstrainers()
Tests if this user can delete offering constrainers.
|
boolean |
canManageOfferingConstrainerAliases()
Tests if this user can manage
Id aliases for offering
constrainers. |
boolean |
canUpdateOfferingConstrainers()
Tests if this user can update offering constrainers.
|
OfferingConstrainer |
createOfferingConstrainer(OfferingConstrainerForm offeringConstrainerForm)
Creates a new
OfferingConstrainer. |
void |
deleteOfferingConstrainer(Id offeringConstrainerId)
Deletes an
OfferingConstrainer. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
OfferingConstrainerForm |
getOfferingConstrainerFormForCreate(Type[] offeringConstrainerRecordTypes)
Gets the offering constrainer form for creating new offering
constrainers.
|
OfferingConstrainerForm |
getOfferingConstrainerFormForUpdate(Id offeringConstrainerId)
Gets the offering constrainer form for updating an existing offering
constrainer.
|
void |
updateOfferingConstrainer(OfferingConstrainerForm offeringConstrainerForm)
Updates an existing offering constrainer.
|
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 canCreateOfferingConstrainer()
OfferingConstrainer
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 OfferingConstrainer
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateOfferingConstrainerWithRecordTypes(Type[] offeringConstrainerRecordTypes)
OfferingRulesManager.getOfferingConstrainerRecordTypes()
can be used to examine which records are supported, this
method tests which record(s) are required for creating a specific
OfferingConstrainer.
Providing an empty array tests if
an OfferingConstrainer
can be created with no records.offeringConstrainerRecordTypes
- array of offering constrainer
record types true
if OfferingConstrainer
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
offeringConstrainerRecordTypes
is null
mandatory
- This method must be implemented. OfferingConstrainerForm getOfferingConstrainerFormForCreate(Type[] offeringConstrainerRecordTypes) throws OperationFailedException, PermissionDeniedException
offeringConstrainerRecordTypes
- array of offering constrainer
record typesNullArgumentException
-
offeringConstrainerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. OfferingConstrainer createOfferingConstrainer(OfferingConstrainerForm offeringConstrainerForm) throws OperationFailedException, PermissionDeniedException
OfferingConstrainer.
offeringConstrainerForm
- the form for this
OfferingConstrainer
OfferingConstrainer
IllegalStateException
- offeringConstrainerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- offeringConstrainerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- offeringConstrainerForm
did not originate from
getOfferingConstrainerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateOfferingConstrainers()
OfferingConstrainer
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 OfferingConstrainer
modification is not authorized, true
otherwisemandatory
- This method must be implemented. OfferingConstrainerForm getOfferingConstrainerFormForUpdate(Id offeringConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
offeringConstrainerId
- the Id
of the
OfferingConstrainer
NotFoundException
- offeringConstrainerId
is not foundNullArgumentException
- offeringConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateOfferingConstrainer(OfferingConstrainerForm offeringConstrainerForm) throws OperationFailedException, PermissionDeniedException
offeringConstrainerForm
- the form containing the elements to be
updatedIllegalStateException
- offeringConstrainerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- offeringConstrainerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- offeringConstrainerForm
did not originate from
getOfferingConstrainerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteOfferingConstrainers()
OfferingConstrainer
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 OfferingConstrainer
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteOfferingConstrainer(Id offeringConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainer.
offeringConstrainerId
- the Id
of the
OfferingConstrainer
to removeNotFoundException
- offeringConstrainerId
not foundNullArgumentException
- offeringConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageOfferingConstrainerAliases()
Id
aliases for offering
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 OfferingConstrainer
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasOfferingConstrainer(Id offeringConstrainerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to an OfferingConstrainer
for
the purpose of creating compatibility. The primary Id
of the OfferingConstrainer
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. it is reassigned to the given offering
constrainer Id.
offeringConstrainerId
- the Id
of an
OfferingConstrainer
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- offeringConstrainerId
not foundNullArgumentException
- offeringConstrainerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.