Interface BallotConstrainerPollsAssignmentSession

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

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

  • Method Details

    • canAssignBallotConstrainers

      boolean canAssignBallotConstrainers()
      Tests if this user can alter ballot 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.

    • canAssignBallotConstrainersToPolls

      boolean canAssignBallotConstrainersToPolls(Id pollsId)
      Tests if this user can alter ballot 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 ballot 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.

    • getAssignablePollsIdsForBallotConstrainer

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

    • assignBallotConstrainerToPolls

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

    • unassignBallotConstrainerFromPolls

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

    • reassignBallotConstrainerToPolls

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