public interface CanonicalUnitProcessorAdminSession extends OsidSession
This session creates and removes canonical unit processors. The data
for create and update is provided via the
CanonicalUnitProcessorForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasCanonicalUnitProcessor(Id canonicalUnitProcessorId,
Id aliasId)
Adds an
Id to a CanonicalUnitProcessor
for the purpose of creating compatibility. |
boolean |
canCreateCanonicalUnitProcessor()
Tests if this user can create canonical unit processors.
|
boolean |
canCreateCanonicalUnitProcessorWithRecordTypes(Type[] canonicalUnitProcessorRecordTypes)
Tests if this user can create a single
CanonicalUnitProcessor
using the desired record types. |
boolean |
canDeleteCanonicalUnitProcessors()
Tests if this user can delete canonical unit processors.
|
boolean |
canManageCanonicalUnitProcessorAliases()
Tests if this user can manage
Id aliases for canonical
unit processors. |
boolean |
canUpdateCanonicalUnitProcessors()
Tests if this user can update canonical unit processors.
|
CanonicalUnitProcessor |
createCanonicalUnitProcessor(CanonicalUnitProcessorForm canonicalUnitProcessorForm)
Creates a new
CanonicalUnitProcessor. |
void |
deleteCanonicalUnitProcessor(Id canonicalUnitProcessorId)
Deletes a
CanonicalUnitProcessor. |
CanonicalUnitProcessorForm |
getCanonicalUnitProcessorFormForCreate(Type[] canonicalUnitProcessorRecordTypes)
Gets the canonical unit processor form for creating new canonical unit
processors.
|
CanonicalUnitProcessorForm |
getCanonicalUnitProcessorFormForUpdate(Id canonicalUnitProcessorId)
Gets the canonical unit processor form for updating an existing
canonical unit processor.
|
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
void |
updateCanonicalUnitProcessor(CanonicalUnitProcessorForm canonicalUnitProcessorForm)
Updates an existing canonical unit processor.
|
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 canCreateCanonicalUnitProcessor()
CanonicalUnitProcessor
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 CanonicalUnitProcessor
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateCanonicalUnitProcessorWithRecordTypes(Type[] canonicalUnitProcessorRecordTypes)
CanonicalUnitProcessor
using the desired record types. While
OfferingRulesManager.getCanonicalUnitProcessorRecordTypes()
can be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
CanonicalUnitProcessor.
Providing an empty array tests if a
CanonicalUnitProcessor
can be created with no records.canonicalUnitProcessorRecordTypes
- array of canonical unit
processor record types true
if CanonicalUnitProcessor
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
canonicalUnitProcessorRecordTypes
is null
mandatory
- This method must be implemented. CanonicalUnitProcessorForm getCanonicalUnitProcessorFormForCreate(Type[] canonicalUnitProcessorRecordTypes) throws OperationFailedException, PermissionDeniedException
canonicalUnitProcessorRecordTypes
- array of canonical unit
processor record typesNullArgumentException
-
canonicalUnitProcessorRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. CanonicalUnitProcessor createCanonicalUnitProcessor(CanonicalUnitProcessorForm canonicalUnitProcessorForm) throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessor.
canonicalUnitProcessorForm
- the form for this
CanonicalUnitProcessor
CanonicalUnitProcessor
IllegalStateException
-
canonicalUnitProcessorForm
already used in a create
transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
-
canonicalUnitProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
canonicalUnitProcessorForm did not originate from
getCanonicalUnitProcessorFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateCanonicalUnitProcessors()
CanonicalUnitProcessor
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 CanonicalUnitProcessor
modification is not authorized, true
otherwisemandatory
- This method must be implemented. CanonicalUnitProcessorForm getCanonicalUnitProcessorFormForUpdate(Id canonicalUnitProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
canonicalUnitProcessorId
- the Id
of the
CanonicalUnitProcessor
NotFoundException
- canonicalUnitProcessorId
is not foundNullArgumentException
- canonicalUnitProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateCanonicalUnitProcessor(CanonicalUnitProcessorForm canonicalUnitProcessorForm) throws OperationFailedException, PermissionDeniedException
canonicalUnitProcessorForm
- the form containing the elements to
be updatedIllegalStateException
-
canonicalUnitProcessorForm
already used in an update
transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
-
canonicalUnitProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
canonicalUnitProcessorForm did not originate from
getCanonicalUnitProcessorFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteCanonicalUnitProcessors()
CanonicalUnitProcessor
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 CanonicalUnitProcessor
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteCanonicalUnitProcessor(Id canonicalUnitProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessor.
canonicalUnitProcessorId
- the Id
of the
CanonicalUnitProcessor
to removeNotFoundException
- canonicalUnitProcessorId
not foundNullArgumentException
- canonicalUnitProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageCanonicalUnitProcessorAliases()
Id
aliases for canonical
unit processors. 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 CanonicalUnitProcessor
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasCanonicalUnitProcessor(Id canonicalUnitProcessorId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a CanonicalUnitProcessor
for the purpose of creating compatibility. The primary Id
of the CanonicalUnitProcessor
is determined by
the provider. The new Id
performs as an alias to the
primary Id
. If the alias is a pointer to another
canonical unit processor. it is reassigned to the given canonical unit
processor Id.
canonicalUnitProcessorId
- the Id
of a
CanonicalUnitProcessor
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- canonicalUnitProcessorId
not foundNullArgumentException
- canonicalUnitProcessorId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.