Interface RaceProcessorPollsAssignmentSession

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

This session provides methods to re-assign RaceProcessor to Polls mappings. a RaceProcessor may appear in multiple Polls objects and removing the last reference to a RaceProcessor is the equivalent of deleting it. Each Polls may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a RaceProcessor to another Polls is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignRaceProcessors

      boolean canAssignRaceProcessors()
      Tests if this user can alter race processor/polls 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.

    • canAssignRaceProcessorsToPolls

      boolean canAssignRaceProcessorsToPolls(Id pollsId)
      Tests if this user can alter race processor/polls 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.
      Parameters:
      pollsId - the Id of the Polls
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - pollsId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignablePollsIds

      IdList getAssignablePollsIds(Id pollsId) throws OperationFailedException
      Gets a list of polls including and under the given polls node in which any race processor can be assigned.
      Parameters:
      pollsId - the Id of the Polls
      Returns:
      list of assignable polls Ids
      Throws:
      NullArgumentException - pollsId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignablePollsIdsForRaceProcessor

      IdList getAssignablePollsIdsForRaceProcessor(Id pollsId, Id raceProcessorId) throws OperationFailedException
      Gets a list of polls including and under the given polls node in which a specific race processor can be assigned.
      Parameters:
      pollsId - the Id of the Polls
      raceProcessorId - the Id of the RaceProcessor
      Returns:
      list of assignable polls Ids
      Throws:
      NullArgumentException - pollsId or raceProcessorId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignRaceProcessorToPolls

      void assignRaceProcessorToPolls(Id raceProcessorId, Id pollsId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing RaceProcessor to a Polls .
      Parameters:
      raceProcessorId - the Id of the RaceProcessor
      pollsId - the Id of the Polls
      Throws:
      AlreadyExistsException - raceProcessorId is already assigned to pollsId
      NotFoundException - raceProcessorId or pollsId not found
      NullArgumentException - raceProcessorId or pollsId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignRaceProcessorFromPolls

      void unassignRaceProcessorFromPolls(Id raceProcessorId, Id pollsId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a RaceProcessor from a Polls .
      Parameters:
      raceProcessorId - the Id of the RaceProcessor
      pollsId - the Id of the Polls
      Throws:
      NotFoundException - raceProcessorId or pollsId not found or raceProcessorId not assigned to pollsId
      NullArgumentException - raceProcessorId or pollsId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignRaceProcessorToPolls

      void reassignRaceProcessorToPolls(Id raceProcessorId, Id fromPollsId, Id toPollsId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves a RaceProcessor from one Polls to another. Mappings to other Polls are unaffected.
      Parameters:
      raceProcessorId - the Id of the RaceProcessor
      fromPollsId - the Id of the current Polls
      toPollsId - the Id of the destination Polls
      Throws:
      AlreadyExistsException - raceProcessorId already assigned to toPollsId
      NotFoundException - raceProcessorId, fromPollsId , or toPollsId not found or raceProcessorId not mapped to fromPollsId
      NullArgumentException - raceProcessorId, fromPollsId , or toPollsId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.