org.osid.mapping.path.rules

Interface SignalEnablerAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface SignalEnablerAdminSession
extends OsidSession

This session creates and removes signal enablers. The data for create and update is provided via the SignalEnablerForm.

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasSignalEnabler(Id signalEnablerId, Id aliasId) Adds an Id to a SignalEnabler for the purpose of creating compatibility.
boolean	canCreateSignalEnabler() Tests if this user can create signal enablers.
boolean	canCreateSignalEnablerWithRecordTypes(Type[] signalEnablerRecordTypes) Tests if this user can create a single SignalEnabler using the desired record types.
boolean	canDeleteSignalEnablers() Tests if this user can delete signal enablers.
boolean	canManageSignalEnablerAliases() Tests if this user can manage Id aliases for signal enablers.
boolean	canUpdateSignalEnablers() Tests if this user can update signal enablers.
SignalEnabler	createSignalEnabler(SignalEnablerForm signalEnablerForm) Creates a new SignalEnabler.
void	deleteSignalEnabler(Id signalEnablerId) Deletes a SignalEnabler.
Map	getMap() Gets the Map associated with this session.
Id	getMapId() Gets the Map Id associated with this session.
SignalEnablerForm	getSignalEnablerFormForCreate(Type[] signalEnablerRecordTypes) Gets the signal enabler form for creating new signal enablers.
SignalEnablerForm	getSignalEnablerFormForUpdate(Id signalEnablerId) Gets the signal enabler form for updating an existing signal enabler.
void	updateSignalEnabler(SignalEnablerForm signalEnablerForm) Updates an existing signal enabler.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getMapId

Id getMapId()

Gets the Map Id associated with this session.

Returns:

the Map Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMap

Map getMap()
           throws OperationFailedException,
                  PermissionDeniedException

Gets the Map associated with this session.

Returns:

the map

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateSignalEnabler

boolean canCreateSignalEnabler()

Tests if this user can create signal enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a SignalEnabler 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.

Returns:

false if SignalEnabler creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateSignalEnablerWithRecordTypes

boolean canCreateSignalEnablerWithRecordTypes(Type[] signalEnablerRecordTypes)

Tests if this user can create a single SignalEnabler using the desired record types. While MappingPathRulesManager.getSignalEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific SignalEnabler. Providing an empty array tests if a SignalEnabler can be created with no records.

Parameters:

signalEnablerRecordTypes - array of signal enabler record types

Returns:

true if SignalEnabler creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - signalEnablerRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getSignalEnablerFormForCreate

SignalEnablerForm getSignalEnablerFormForCreate(Type[] signalEnablerRecordTypes)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets the signal enabler form for creating new signal enablers. A new form should be requested for each create transaction.

Parameters:

signalEnablerRecordTypes - array of signal enabler record types

Returns:

the signal enabler form

Throws:

NullArgumentException - signalEnablerRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createSignalEnabler

SignalEnabler createSignalEnabler(SignalEnablerForm signalEnablerForm)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Creates a new SignalEnabler.

Parameters:

signalEnablerForm - the form for this SignalEnabler

Returns:

the new SignalEnabler

Throws:

IllegalStateException - signalEnablerForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - signalEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - signalEnablerForm did not originate from getSignalEnablerFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateSignalEnablers

boolean canUpdateSignalEnablers()

Tests if this user can update signal enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a SignalEnabler 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.

Returns:

false if SignalEnabler modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getSignalEnablerFormForUpdate

SignalEnablerForm getSignalEnablerFormForUpdate(Id signalEnablerId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the signal enabler form for updating an existing signal enabler. A new signal enabler form should be requested for each update transaction.

Parameters:

signalEnablerId - the Id of the SignalEnabler

Returns:

the signal enabler form

Throws:

NotFoundException - signalEnablerId is not found

NullArgumentException - signalEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateSignalEnabler

void updateSignalEnabler(SignalEnablerForm signalEnablerForm)
                         throws OperationFailedException,
                                PermissionDeniedException

Updates an existing signal enabler.

Parameters:

signalEnablerForm - the form containing the elements to be updated

Throws:

IllegalStateException - signalEnablerForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - signalEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - signalEnablerForm did not originate from getSignalEnablerFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteSignalEnablers

boolean canDeleteSignalEnablers()

Tests if this user can delete signal enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a SignalEnabler 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.

Returns:

false if SignalEnabler deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteSignalEnabler

void deleteSignalEnabler(Id signalEnablerId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Deletes a SignalEnabler.

Parameters:

signalEnablerId - the Id of the SignalEnabler to remove

Throws:

NotFoundException - signalEnablerId not found

NullArgumentException - signalEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSignalEnablerAliases

boolean canManageSignalEnablerAliases()

Tests if this user can manage Id aliases for signal 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.

Returns:

false if SignalEnabler aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasSignalEnabler

void aliasSignalEnabler(Id signalEnablerId,
                      Id aliasId)
                        throws AlreadyExistsException,
                               NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Adds an Id to a SignalEnabler for the purpose of creating compatibility. The primary Id of the SignalEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another signal enabler. it is reassigned to the given signal enabler Id.

Parameters:

signalEnablerId - the Id of a SignalEnabler

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - signalEnablerId not found

NullArgumentException - signalEnablerId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.