Interface RaceConstrainerPollsAssignmentSession

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

This session provides methods to re-assign RaceConstrainer to Polls mappings. a RaceConstrainer may appear in multiple Polls objects and removing the last reference to a RaceConstrainer 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 RaceConstrainer to another Polls is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignRaceConstrainers

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

    • canAssignRaceConstrainersToPolls

      boolean canAssignRaceConstrainersToPolls(Id pollsId)
      Tests if this user can alter race constrainer/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 constrainer 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.

    • getAssignablePollsIdsForRaceConstrainer

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

    • assignRaceConstrainerToPolls

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

    • unassignRaceConstrainerFromPolls

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

    • reassignRaceConstrainerToPolls

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