public interface CanonicalUnitProcessorEnablerAdminSession extends OsidSession
This session creates and removes canonical unit processor enablers. The
data for create and update is provided via the
CanonicalUnitProcessorEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId,
Id aliasId)
Adds an
Id to a CanonicalUnitProcessorEnabler
for the purpose of creating compatibility. |
boolean |
canCreateCanonicalUnitProcessorEnabler()
Tests if this user can create canonical unit processor enablers.
|
boolean |
canCreateCanonicalUnitProcessorEnablerWithRecordTypes(Type[] canonicalUnitProcessorEnablerRecordTypes)
Tests if this user can create a single
CanonicalUnitProcessorEnabler using the desired record types. |
boolean |
canDeleteCanonicalUnitProcessorEnablers()
Tests if this user can delete canonical unit processor enablers.
|
boolean |
canManageCanonicalUnitProcessorEnablerAliases()
Tests if this user can manage
Id aliases for canonical
unit processor enablers. |
boolean |
canUpdateCanonicalUnitProcessorEnablers()
Tests if this user can update canonical unit processor enablers.
|
CanonicalUnitProcessorEnabler |
createCanonicalUnitProcessorEnabler(CanonicalUnitProcessorEnablerForm canonicalUnitProcessorEnablerForm)
Creates a new
CanonicalUnitProcessorEnabler. |
void |
deleteCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId)
Deletes a
CanonicalUnitProcessorEnabler. |
CanonicalUnitProcessorEnablerForm |
getCanonicalUnitProcessorEnablerFormForCreate(Type[] canonicalUnitProcessorEnablerRecordTypes)
Gets the canonical unit processor enabler form for creating new
canonical unit processor enablers.
|
CanonicalUnitProcessorEnablerForm |
getCanonicalUnitProcessorEnablerFormForUpdate(Id canonicalUnitProcessorEnablerId)
Gets the canonical unit processor enabler form for updating an
existing canonical unit processor enabler.
|
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
void |
updateCanonicalUnitProcessorEnabler(CanonicalUnitProcessorEnablerForm canonicalUnitProcessorEnablerForm)
Updates an existing canonical unit processor 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 canCreateCanonicalUnitProcessorEnabler()
CanonicalUnitProcessorEnabler
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 CanonicalUnitProcessorEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateCanonicalUnitProcessorEnablerWithRecordTypes(Type[] canonicalUnitProcessorEnablerRecordTypes)
CanonicalUnitProcessorEnabler
using the desired record types.
While
OfferingRulesManager.getCanonicalUnitProcessorEnablerRecordTypes()
can be used to examine which records are supported, this
method tests which record(s) are required for creating a specific
CanonicalUnitProcessorEnabler.
Providing an empty array
tests if a CanonicalUnitProcessorEnabler
can be created
with no records.canonicalUnitProcessorEnablerRecordTypes
- array of canonical
unit processor enabler record types true
if CanonicalUnitProcessorEnabler
creation using the specified record Types
is supported, false
otherwiseNullArgumentException
-
canonicalUnitProcessorEnablerRecordTypes
is
null
mandatory
- This method must be implemented. CanonicalUnitProcessorEnablerForm getCanonicalUnitProcessorEnablerFormForCreate(Type[] canonicalUnitProcessorEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
canonicalUnitProcessorEnablerRecordTypes
- array of canonical
unit processor enabler record typesNullArgumentException
-
canonicalUnitProcessorEnablerRecordTypes
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. CanonicalUnitProcessorEnabler createCanonicalUnitProcessorEnabler(CanonicalUnitProcessorEnablerForm canonicalUnitProcessorEnablerForm) throws OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnabler.
canonicalUnitProcessorEnablerForm
- the form for this
CanonicalUnitProcessorEnabler
CanonicalUnitProcessorEnabler
IllegalStateException
-
canonicalUnitProcessorEnablerForm
already used in a
create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
-
canonicalUnitProcessorEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
canonicalUnitProcessorEnablerForm did not originate from
getCanonicalUnitProcessorEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateCanonicalUnitProcessorEnablers()
CanonicalUnitProcessorEnabler
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 CanonicalUnitProcessorEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. CanonicalUnitProcessorEnablerForm getCanonicalUnitProcessorEnablerFormForUpdate(Id canonicalUnitProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
canonicalUnitProcessorEnablerId
- the Id
of the
CanonicalUnitProcessorEnabler
NotFoundException
-
canonicalUnitProcessorEnablerId
is not foundNullArgumentException
-
canonicalUnitProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateCanonicalUnitProcessorEnabler(CanonicalUnitProcessorEnablerForm canonicalUnitProcessorEnablerForm) throws OperationFailedException, PermissionDeniedException
canonicalUnitProcessorEnablerForm
- the form containing the
elements to be updatedIllegalStateException
-
canonicalUnitProcessorEnablerForm
already used in an
update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
-
canonicalUnitProcessorEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
canonicalUnitProcessorEnablerForm did not originate from
getCanonicalUnitProcessorEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteCanonicalUnitProcessorEnablers()
CanonicalUnitProcessorEnabler
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 CanonicalUnitProcessorEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CanonicalUnitProcessorEnabler.
canonicalUnitProcessorEnablerId
- the Id
of the
CanonicalUnitProcessorEnabler
to removeNotFoundException
-
canonicalUnitProcessorEnablerId
not foundNullArgumentException
-
canonicalUnitProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageCanonicalUnitProcessorEnablerAliases()
Id
aliases for canonical
unit processor 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 CanonicalUnitProcessorEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a CanonicalUnitProcessorEnabler
for the purpose of creating compatibility. The primary
Id
of the CanonicalUnitProcessorEnabler
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 enabler. it is reassigned to the
given canonical unit processor enabler Id.
canonicalUnitProcessorEnablerId
- the Id
of a
CanonicalUnitProcessorEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
-
canonicalUnitProcessorEnablerId
not foundNullArgumentException
-
canonicalUnitProcessorEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.