Interface ObstacleEnablerAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ObstacleEnablerAdminSession extends OsidSession

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

  • Method Details

    • 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.

    • canCreateObstacleEnabler

      boolean canCreateObstacleEnabler()
      Tests if this user can create obstacle enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an 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.
      Returns:
      false if ObstacleEnabler creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateObstacleEnablerWithRecordTypes

      boolean canCreateObstacleEnablerWithRecordTypes(Type[] obstacleEnablerRecordTypes)
      Tests if this user can create a single 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.
      Parameters:
      obstacleEnablerRecordTypes - array of obstacle enabler record types
      Returns:
      true if ObstacleEnabler creation using the specified record Types is supported, false otherwise
      Throws:
      NullArgumentException - obstacleEnablerRecordTypes is null
      Compliance:
      mandatory - This method must be implemented.

    • getObstacleEnablerFormForCreate

      ObstacleEnablerForm getObstacleEnablerFormForCreate(Type[] obstacleEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the obstacle enabler form for creating new obstacle enablers. A new form should be requested for each create transaction.
      Parameters:
      obstacleEnablerRecordTypes - array of obstacle enabler record types
      Returns:
      the obstacle enabler form
      Throws:
      NullArgumentException - obstacleEnablerRecordTypes 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.

    • createObstacleEnabler

      ObstacleEnabler createObstacleEnabler(ObstacleEnablerForm obstacleEnablerForm) throws OperationFailedException, PermissionDeniedException
      Creates a new ObstacleEnabler .
      Parameters:
      obstacleEnablerForm - the form for this ObstacleEnabler
      Returns:
      the new ObstacleEnabler
      Throws:
      IllegalStateException - obstacleEnablerForm already used in a create transaction
      InvalidArgumentException - one or more of the form elements is invalid
      NullArgumentException - obstacleEnablerForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - obstacleEnablerForm did not originate from getObstacleEnablerFormForCreate()
      Compliance:
      mandatory - This method must be implemented.

    • canUpdateObstacleEnablers

      boolean canUpdateObstacleEnablers()
      Tests if this user can update obstacle enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an 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.
      Returns:
      false if ObstacleEnabler modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getObstacleEnablerFormForUpdate

      ObstacleEnablerForm getObstacleEnablerFormForUpdate(Id obstacleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the obstacle enabler form for updating an existing obstacle enabler. A new obstacle enabler form should be requested for each update transaction.
      Parameters:
      obstacleEnablerId - the Id of the ObstacleEnabler
      Returns:
      the obstacle enabler form
      Throws:
      NotFoundException - obstacleEnablerId is not found
      NullArgumentException - obstacleEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • updateObstacleEnabler

      void updateObstacleEnabler(ObstacleEnablerForm obstacleEnablerForm) throws OperationFailedException, PermissionDeniedException
      Updates an existing obstacle enabler.
      Parameters:
      obstacleEnablerForm - the form containing the elements to be updated
      Throws:
      IllegalStateException - obstacleEnablerForm already used in an update transaction
      InvalidArgumentException - the form contains an invalid value
      NullArgumentException - obstacleEnablerForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - obstacleEnablerForm did not originate from getObstacleEnablerFormForUpdate()
      Compliance:
      mandatory - This method must be implemented.

    • canDeleteObstacleEnablers

      boolean canDeleteObstacleEnablers()
      Tests if this user can delete obstacle enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an 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.
      Returns:
      false if ObstacleEnabler deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteObstacleEnabler

      void deleteObstacleEnabler(Id obstacleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Deletes an ObstacleEnabler .
      Parameters:
      obstacleEnablerId - the Id of the ObstacleEnabler to remove
      Throws:
      NotFoundException - obstacleEnablerId not found
      NullArgumentException - obstacleEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageObstacleEnablerAliases

      boolean canManageObstacleEnablerAliases()
      Tests if this user can manage 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.
      Returns:
      false if ObstacleEnabler aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasObstacleEnabler

      void aliasObstacleEnabler(Id obstacleEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an 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 .
      Parameters:
      obstacleEnablerId - the Id of an ObstacleEnabler
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - obstacleEnablerId not found
      NullArgumentException - obstacleEnablerId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.