public interface SpeedZoneEnablerAdminSession extends OsidSession
This session creates and removes speed zone enablers. The data for
create and update is provided via the SpeedZoneEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasSpeedZoneEnabler(Id speedZoneEnablerId,
Id aliasId)
Adds a
Id to a SpeedZoneEnabler for the
purpose of creating compatibility. |
boolean |
canCreateSpeedZoneEnabler()
Tests if this user can create speed zone enablers.
|
boolean |
canCreateSpeedZoneEnablerWithRecordTypes(Type[] speedZoneEnablerRecordTypes)
Tests if this user can create a single
SpeedZoneEnabler
using the desired record types. |
boolean |
canDeleteSpeedZoneEnablers()
Tests if this user can delete speed zone enablers.
|
boolean |
canManageSpeedZoneEnablerAliases()
Tests if this user can manage
Id aliases for speed zone
enablers. |
boolean |
canUpdateSpeedZoneEnablers()
Tests if this user can update speed zone enablers.
|
SpeedZoneEnabler |
createSpeedZoneEnabler(SpeedZoneEnablerForm speedZoneEnablerForm)
Creates a new
SpeedZoneEnabler. |
void |
deleteSpeedZoneEnabler(Id speedZoneEnablerId)
Deletes a
SpeedZoneEnabler. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
SpeedZoneEnablerForm |
getSpeedZoneEnablerFormForCreate(Type[] speedZoneEnablerRecordTypes)
Gets the speed zone enabler form for creating new speed zone enablers.
|
SpeedZoneEnablerForm |
getSpeedZoneEnablerFormForUpdate(Id speedZoneEnablerId)
Gets the speed zone enabler form for updating an existing speed zone
enabler.
|
void |
updateSpeedZoneEnabler(SpeedZoneEnablerForm speedZoneEnablerForm)
Updates an existing speed zone 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 canCreateSpeedZoneEnabler()
SpeedZoneEnabler
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 SpeedZoneEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateSpeedZoneEnablerWithRecordTypes(Type[] speedZoneEnablerRecordTypes)
SpeedZoneEnabler
using the desired record types. While
MappingPathRulesManager.getSpeedZoneEnablerRecordTypes()
can
be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
SpeedZoneEnabler.
Providing an empty array tests if a
SpeedZoneEnabler
can be created with no records.speedZoneEnablerRecordTypes
- array of speed zone enabler record
types true
if SpeedZoneEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
speedZoneEnablerRecordTypes
is null
mandatory
- This method must be implemented. SpeedZoneEnablerForm getSpeedZoneEnablerFormForCreate(Type[] speedZoneEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
speedZoneEnablerRecordTypes
- array of speed zone enabler record
typesNullArgumentException
-
speedZoneEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. SpeedZoneEnabler createSpeedZoneEnabler(SpeedZoneEnablerForm speedZoneEnablerForm) throws OperationFailedException, PermissionDeniedException
SpeedZoneEnabler.
speedZoneEnablerForm
- the form for this SpeedZoneEnabler
SpeedZoneEnabler
IllegalStateException
- speedZoneEnablerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- speedZoneEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- speedZoneEnablerForm
did not originate from
getSpeedZoneEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateSpeedZoneEnablers()
SpeedZoneEnabler
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 SpeedZoneEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. SpeedZoneEnablerForm getSpeedZoneEnablerFormForUpdate(Id speedZoneEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
speedZoneEnablerId
- the Id
of the
SpeedZoneEnabler
NotFoundException
- speedZoneEnablerId
is not foundNullArgumentException
- speedZoneEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateSpeedZoneEnabler(SpeedZoneEnablerForm speedZoneEnablerForm) throws OperationFailedException, PermissionDeniedException
speedZoneEnablerForm
- the form containing the elements to be
updatedIllegalStateException
- speedZoneEnablerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- speedZoneEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- speedZoneEnablerForm
did not originate from
getSpeedZoneEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteSpeedZoneEnablers()
SpeedZoneEnabler
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 SpeedZoneEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteSpeedZoneEnabler(Id speedZoneEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZoneEnabler.
speedZoneEnablerId
- the Id
of the
SpeedZoneEnabler
to removeNotFoundException
- speedZoneEnablerId
not foundNullArgumentException
- speedZoneEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSpeedZoneEnablerAliases()
Id
aliases for speed zone
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 SpeedZoneEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasSpeedZoneEnabler(Id speedZoneEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a SpeedZoneEnabler
for the
purpose of creating compatibility. The primary Id
of
the SpeedZoneEnabler
is determined by the provider. The
new Id
performs as an alias to the primary Id
. If the alias is a pointer to another speed zone enabler. it
is reassigned to the given speed zone enabler Id.
speedZoneEnablerId
- the Id
of a
SpeedZoneEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- speedZoneEnablerId
not foundNullArgumentException
- speedZoneEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.