Interface PoolProcessorRuleApplicationSession

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

This session provides methods to apply PoolProcessors to Pools . Multiple PoolProcessors applied to an Pool may be sequenced such that the first positive evaluation results in the PoolProcessor used.

  • Method Details

    • getDistributorId

      Id getDistributorId()
      Gets the Distributor Id associated with this session.
      Returns:
      the Distributor Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getDistributor

      Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
      Gets the Distributor associated with this session.
      Returns:
      the distributor
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canAssignPoolProcessors

      boolean canAssignPoolProcessors()
      Tests if this user can alter pool processor/pool mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED .This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • assignPoolProcessorToPool

      void assignPoolProcessorToPool(Id poolProcessorId, Id poolId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing PoolProcessor to a Pool .
      Parameters:
      poolProcessorId - the Id of the PoolProcessor
      poolId - the Id of the Pool
      Throws:
      AlreadyExistsException - poolProcessorId already applied to poolId
      NotFoundException - poolProcessorId or poolId not found
      NullArgumentException - poolProcessorId or poolId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignPoolProcessorFromPool

      void unassignPoolProcessorFromPool(Id poolProcessorId, Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes an existing PoolProcessor from a Pool .
      Parameters:
      poolProcessorId - the Id of the PoolProcessor
      poolId - the Id of the Pool
      Throws:
      NotFoundException - poolProcessorId or poolId not found or poolProcessorId already applied to poolId
      NullArgumentException - poolProcessorId or poolId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSequencePoolProcessors

      boolean canSequencePoolProcessors()
      Tests if this user can order PoolProcessors . A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED .This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
      Returns:
      false if PoolProcessor ordering is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • movePoolProcessorAhead

      void movePoolProcessorAhead(Id poolProcessorId, Id poolId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Reorders pool processors for a pool by moving the specified pool processor in front of a reference pool processor.
      Parameters:
      poolProcessorId - the Id of the PoolProcessor
      poolId - the Id of the Pool
      referenceId - the reference pool processor Id
      Throws:
      NotFoundException - poolProcessorId poolId , or referenceId not found or, poolProcessorId or referenceId not related to poolId
      NullArgumentException - poolProcessorId, poolId , or referenceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • movePoolProcessorBehind

      void movePoolProcessorBehind(Id poolProcessorId, Id poolId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Reorders pool processors for a pool by moving the specified pool processor behind a reference pool processor.
      Parameters:
      poolProcessorId - the Id of the PoolProcessor
      poolId - the Id of the Pool
      referenceId - the reference pool processor Id
      Throws:
      NotFoundException - poolProcessorId, poolId , or referenceId not found or, poolProcessorId or referenceId not related to poolId
      NullArgumentException - poolProcessorId, poolId , or referenceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • orderPoolProcessors

      void orderPoolProcessors(Id[] poolProcessorIds, Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Reorders a set of pool processors for a pool.
      Parameters:
      poolProcessorIds - the Ids for a set of PoolProcessors
      poolId - the Id of the Pool
      Throws:
      NotFoundException - poolId not found or, a poolProcessorId not related to poolId
      NullArgumentException - poolProcessorIds or poolId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.