public interface ObstacleEnablerAdminSession extends OsidSession
This session creates and removes obstacle enablers. The data for create
and update is provided via the ObstacleEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasObstacleEnabler(Id obstacleEnablerId,
Id aliasId)
Adds an
Id to an ObstacleEnabler for the
purpose of creating compatibility. |
boolean |
canCreateObstacleEnabler()
Tests if this user can create obstacle enablers.
|
boolean |
canCreateObstacleEnablerWithRecordTypes(Type[] obstacleEnablerRecordTypes)
Tests if this user can create a single
ObstacleEnabler
using the desired record types. |
boolean |
canDeleteObstacleEnablers()
Tests if this user can delete obstacle enablers.
|
boolean |
canManageObstacleEnablerAliases()
Tests if this user can manage
Id aliases for obstacle
enablers. |
boolean |
canUpdateObstacleEnablers()
Tests if this user can update obstacle enablers.
|
ObstacleEnabler |
createObstacleEnabler(ObstacleEnablerForm obstacleEnablerForm)
Creates a new
ObstacleEnabler. |
void |
deleteObstacleEnabler(Id obstacleEnablerId)
Deletes an
ObstacleEnabler. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
ObstacleEnablerForm |
getObstacleEnablerFormForCreate(Type[] obstacleEnablerRecordTypes)
Gets the obstacle enabler form for creating new obstacle enablers.
|
ObstacleEnablerForm |
getObstacleEnablerFormForUpdate(Id obstacleEnablerId)
Gets the obstacle enabler form for updating an existing obstacle
enabler.
|
void |
updateObstacleEnabler(ObstacleEnablerForm obstacleEnablerForm)
Updates an existing obstacle enabler.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapId()
Map
Id
associated with this
session. Map Id
associated with this sessionmandatory
- This method must be implemented. Map getMap() throws OperationFailedException, PermissionDeniedException
Map
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateObstacleEnabler()
ObstacleEnabler
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 ObstacleEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateObstacleEnablerWithRecordTypes(Type[] obstacleEnablerRecordTypes)
ObstacleEnabler
using the desired record types. While
MappingPathRulesManager.getObstacleEnablerRecordTypes()
can be
used to examine which records are supported, this method tests which
record(s) are required for creating a specific ObstacleEnabler.
Providing an empty array tests if an ObstacleEnabler
can be created with no records.obstacleEnablerRecordTypes
- array of obstacle enabler record
types true
if ObstacleEnabler
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
-
obstacleEnablerRecordTypes
is null
mandatory
- This method must be implemented. ObstacleEnablerForm getObstacleEnablerFormForCreate(Type[] obstacleEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
obstacleEnablerRecordTypes
- array of obstacle enabler record
typesNullArgumentException
-
obstacleEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. ObstacleEnabler createObstacleEnabler(ObstacleEnablerForm obstacleEnablerForm) throws OperationFailedException, PermissionDeniedException
ObstacleEnabler.
obstacleEnablerForm
- the form for this ObstacleEnabler
ObstacleEnabler
IllegalStateException
- obstacleEnablerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- obstacleEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- obstacleEnablerForm
did not originate from
getObstacleEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateObstacleEnablers()
ObstacleEnabler
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 ObstacleEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. ObstacleEnablerForm getObstacleEnablerFormForUpdate(Id obstacleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
obstacleEnablerId
- the Id
of the
ObstacleEnabler
NotFoundException
- obstacleEnablerId
is
not foundNullArgumentException
- obstacleEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateObstacleEnabler(ObstacleEnablerForm obstacleEnablerForm) throws OperationFailedException, PermissionDeniedException
obstacleEnablerForm
- the form containing the elements to be
updatedIllegalStateException
- obstacleEnablerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- obstacleEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- obstacleEnablerForm
did not originate from
getObstacleEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteObstacleEnablers()
ObstacleEnabler
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 ObstacleEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteObstacleEnabler(Id obstacleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObstacleEnabler.
obstacleEnablerId
- the Id
of the
ObstacleEnabler
to removeNotFoundException
- obstacleEnablerId
not foundNullArgumentException
- obstacleEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageObstacleEnablerAliases()
Id
aliases for obstacle
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 ObstacleEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasObstacleEnabler(Id obstacleEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to an ObstacleEnabler
for the
purpose of creating compatibility. The primary Id
of
the ObstacleEnabler
is determined by the provider. The
new Id
performs as an alias to the primary Id
. If the alias is a pointer to another obstacle enabler. it is
reassigned to the given obstacle enabler Id.
obstacleEnablerId
- the Id
of an
ObstacleEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- obstacleEnablerId
not foundNullArgumentException
- obstacleEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.