public interface ActionEnablerAdminSession extends OsidSession
This session creates and removes action enablers. The data for create
and update is provided via the ActionEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasActionEnabler(Id actionEnablerId,
Id aliasId)
Adds an
Id to an ActionEnabler for the
purpose of creating compatibility. |
boolean |
canCreateActionEnabler()
Tests if this user can create action enablers.
|
boolean |
canCreateActionEnablerWithRecordTypes(Type[] actionEnablerRecordTypes)
Tests if this user can create a single
ActionEnabler
using the desired record types. |
boolean |
canDeleteActionEnablers()
Tests if this user can delete action enablers.
|
boolean |
canManageActionEnablerAliases()
Tests if this user can manage
Id aliases for action
enablers. |
boolean |
canUpdateActionEnablers()
Tests if this user can update action enablers.
|
ActionEnabler |
createActionEnabler(ActionEnablerForm actionEnablerForm)
Creates a new
ActionEnabler. |
void |
deleteActionEnabler(Id actionEnablerId)
Deletes an
ActionEnabler. |
ActionEnablerForm |
getActionEnablerFormForCreate(Type[] actionEnablerRecordTypes)
Gets the action enabler form for creating new action enablers.
|
ActionEnablerForm |
getActionEnablerFormForUpdate(Id actionEnablerId)
Gets the action enabler form for updating an existing action enabler.
|
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
updateActionEnabler(ActionEnablerForm actionEnablerForm)
Updates an existing action 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 canCreateActionEnabler()
ActionEnabler
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 ActionEnabler
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateActionEnablerWithRecordTypes(Type[] actionEnablerRecordTypes)
ActionEnabler
using the desired record types. While
ControlRulesManager.getActionEnablerRecordTypes()
can be used
to examine which records are supported, this method tests which
record(s) are required for creating a specific ActionEnabler.
Providing an empty array tests if an ActionEnabler
can be created with no records.actionEnablerRecordTypes
- array of action enabler record types true
if ActionEnabler
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
- actionEnablerRecordTypes
is null
mandatory
- This method must be implemented. ActionEnablerForm getActionEnablerFormForCreate(Type[] actionEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
actionEnablerRecordTypes
- array of action enabler record typesNullArgumentException
- actionEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. ActionEnabler createActionEnabler(ActionEnablerForm actionEnablerForm) throws OperationFailedException, PermissionDeniedException
ActionEnabler.
actionEnablerForm
- the form for this ActionEnabler
ActionEnabler
IllegalStateException
- actionEnablerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- actionEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- actionEnablerForm did not
originate from getActionEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateActionEnablers()
ActionEnabler
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 ActionEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. ActionEnablerForm getActionEnablerFormForUpdate(Id actionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
actionEnablerId
- the Id
of the
ActionEnabler
NotFoundException
- actionEnablerId
is
not foundNullArgumentException
- actionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateActionEnabler(ActionEnablerForm actionEnablerForm) throws OperationFailedException, PermissionDeniedException
actionEnablerForm
- the form containing the elements to be
updatedIllegalStateException
- actionEnablerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- actionEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- actionEnablerForm
did not originate from getActionEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteActionEnablers()
ActionEnabler
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 ActionEnabler
deletion
is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteActionEnabler(Id actionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActionEnabler.
actionEnablerId
- the Id
of the
ActionEnabler
to removeNotFoundException
- actionEnablerId
not
foundNullArgumentException
- actionEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageActionEnablerAliases()
Id
aliases for action
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 ActionEnabler
aliasing
is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasActionEnabler(Id actionEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to an ActionEnabler
for the
purpose of creating compatibility. The primary Id
of
the ActionEnabler
is determined by the provider. The
new Id
performs as an alias to the primary Id
. If the alias is a pointer to another action enabler. it is
reassigned to the given action enabler Id.
actionEnablerId
- the Id
of an
ActionEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- actionEnablerId
not
foundNullArgumentException
- actionEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.