public interface InputEnablerAdminSession extends OsidSession
This session creates and removes input enablers. The data for create
and update is provided via the InputEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasInputEnabler(Id inputEnablerId,
Id aliasId)
Adds an
Id to an InputEnabler for the
purpose of creating compatibility. |
boolean |
canCreateInputEnabler()
Tests if this user can create input enablers.
|
boolean |
canCreateInputEnablerWithRecordTypes(Type[] inputEnablerRecordTypes)
Tests if this user can create a single
InputEnabler
using the desired record types. |
boolean |
canDeleteInputEnablers()
Tests if this user can delete input enablers.
|
boolean |
canManageInputEnablerAliases()
Tests if this user can manage
Id aliases for input
enablers. |
boolean |
canUpdateInputEnablers()
Tests if this user can update input enablers.
|
InputEnabler |
createInputEnabler(InputEnablerForm inputEnablerForm)
Creates a new
InputEnabler. |
void |
deleteInputEnabler(Id inputEnablerId)
Deletes an
InputEnabler. |
InputEnablerForm |
getInputEnablerFormForCreate(Type[] inputEnablerRecordTypes)
Gets the input enabler form for creating new input enablers.
|
InputEnablerForm |
getInputEnablerFormForUpdate(Id inputEnablerId)
Gets the input enabler form for updating an existing input enabler.
|
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
updateInputEnabler(InputEnablerForm inputEnablerForm)
Updates an existing input enabler.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateInputEnabler()
InputEnabler
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 InputEnabler
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateInputEnablerWithRecordTypes(Type[] inputEnablerRecordTypes)
InputEnabler
using the desired record types. While
OfferingRulesManager.getInputEnablerRecordTypes()
can be used
to examine which records are supported, this method tests which
record(s) are required for creating a specific InputEnabler.
Providing an empty array tests if an InputEnabler
can be created with no records.inputEnablerRecordTypes
- array of input enabler record types true
if InputEnabler
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
- inputEnablerRecordTypes
is null
mandatory
- This method must be implemented. InputEnablerForm getInputEnablerFormForCreate(Type[] inputEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
inputEnablerRecordTypes
- array of input enabler record typesNullArgumentException
- inputEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. InputEnabler createInputEnabler(InputEnablerForm inputEnablerForm) throws OperationFailedException, PermissionDeniedException
InputEnabler.
inputEnablerForm
- the form for this InputEnabler
InputEnabler
IllegalStateException
- inputEnablerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- inputEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- inputEnablerForm did not
originate from getInputEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateInputEnablers()
InputEnabler
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 InputEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. InputEnablerForm getInputEnablerFormForUpdate(Id inputEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
inputEnablerId
- the Id
of the
InputEnabler
NotFoundException
- inputEnablerId
is
not foundNullArgumentException
- inputEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateInputEnabler(InputEnablerForm inputEnablerForm) throws OperationFailedException, PermissionDeniedException
inputEnablerForm
- the form containing the elements to be
updatedIllegalStateException
- inputEnablerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- inputEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- inputEnablerForm did not
originate from getInputEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteInputEnablers()
InputEnabler
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 InputEnabler
deletion
is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteInputEnabler(Id inputEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InputEnabler.
inputEnablerId
- the Id
of the
InputEnabler
to removeNotFoundException
- inputEnablerId
not
foundNullArgumentException
- inputEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageInputEnablerAliases()
Id
aliases for input
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 InputEnabler
aliasing
is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasInputEnabler(Id inputEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to an InputEnabler
for the
purpose of creating compatibility. The primary Id
of
the InputEnabler
is determined by the provider. The new
Id
performs as an alias to the primary Id
. If the alias is a pointer to another input enabler. it is
reassigned to the given input enabler Id.
inputEnablerId
- the Id
of an InputEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- inputEnablerId
not
foundNullArgumentException
- inputEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.