public interface ParameterProcessorAdminSession extends OsidSession
This session creates and removes parameter processors. The data for
create and update is provided via the ParameterProcessorForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasParameterProcessor(Id parameterProcessorId,
Id aliasId)
Adds an
Id to a ParameterProcessor for
the purpose of creating compatibility. |
boolean |
canCreateParameterProcessor()
Tests if this user can create parameter processors.
|
boolean |
canCreateParameterProcessorWithRecordTypes(Type[] parameterProcessorRecordTypes)
Tests if this user can create a single
ParameterProcessor
using the desired record types. |
boolean |
canDeleteParameterProcessors()
Tests if this user can delete parameter processors.
|
boolean |
canManageParameterProcessorAliases()
Tests if this user can manage
Id aliases for parameter
processors. |
boolean |
canUpdateParameterProcessors()
Tests if this user can update parameter processors.
|
ParameterProcessor |
createParameterProcessor(ParameterProcessorForm parameterProcessorForm)
Creates a new
ParameterProcessor. |
void |
deleteParameterProcessor(Id parameterProcessorId)
Deletes a
ParameterProcessor. |
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
ParameterProcessorForm |
getParameterProcessorFormForCreate(Type[] parameterProcessorRecordTypes)
Gets the parameter processor form for creating new parameter
processors.
|
ParameterProcessorForm |
getParameterProcessorFormForUpdate(Id parameterProcessorId)
Gets the parameter processor form for updating an existing parameter
processor.
|
void |
updateParameterProcessor(ParameterProcessorForm parameterProcessorForm)
Updates an existing parameter processor.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getConfigurationId()
Configuration
Id
associated
with this session. Configuration Id
associated with this
sessionmandatory
- This method must be implemented. Configuration getConfiguration() throws OperationFailedException, PermissionDeniedException
Configuration
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateParameterProcessor()
ParameterProcessor
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 ParameterProcessor
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateParameterProcessorWithRecordTypes(Type[] parameterProcessorRecordTypes)
ParameterProcessor
using the desired record types. While
ConfigurationRulesManager.getParameterProcessorRecordTypes()
can be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
ParameterProcessor.
Providing an empty array tests if a
ParameterProcessor
can be created with no records.parameterProcessorRecordTypes
- array of parameter processor
record types true
if ParameterProcessor
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
parameterProcessorRecordTypes
is null
mandatory
- This method must be implemented. ParameterProcessorForm getParameterProcessorFormForCreate(Type[] parameterProcessorRecordTypes) throws OperationFailedException, PermissionDeniedException
parameterProcessorRecordTypes
- array of parameter processor
record typesNullArgumentException
-
parameterProcessorRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. ParameterProcessor createParameterProcessor(ParameterProcessorForm parameterProcessorForm) throws OperationFailedException, PermissionDeniedException
ParameterProcessor.
parameterProcessorForm
- the form for this
ParameterProcessor
ParameterProcessor
IllegalStateException
- parameterProcessorForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- parameterProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- parameterProcessorForm
did not originate from
getParameterProcessorFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateParameterProcessors()
ParameterProcessor
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 ParameterProcessor
modification is not authorized, true
otherwisemandatory
- This method must be implemented. ParameterProcessorForm getParameterProcessorFormForUpdate(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
parameterProcessorId
- the Id
of the
ParameterProcessor
NotFoundException
- parameterProcessorId
is not foundNullArgumentException
- parameterProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateParameterProcessor(ParameterProcessorForm parameterProcessorForm) throws OperationFailedException, PermissionDeniedException
parameterProcessorForm
- the form containing the elements to be
updatedIllegalStateException
- parameterProcessorForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- parameterProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- parameterProcessorForm
did not originate from
getParameterProcessorFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteParameterProcessors()
ParameterProcessor
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 ParameterProcessor
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteParameterProcessor(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessor.
parameterProcessorId
- the Id
of the
ParameterProcessor
to removeNotFoundException
- parameterProcessorId
not foundNullArgumentException
- parameterProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageParameterProcessorAliases()
Id
aliases for parameter
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 ParameterProcessor
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasParameterProcessor(Id parameterProcessorId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a ParameterProcessor
for
the purpose of creating compatibility. The primary Id
of the ParameterProcessor
is determined by the
provider. The new Id
performs as an alias to the
primary Id
. If the alias is a pointer to another
parameter processor. it is reassigned to the given parameter processor
Id.
parameterProcessorId
- the Id
of a
ParameterProcessor
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- parameterProcessorId
not foundNullArgumentException
- parameterProcessorId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.