Interface CandidatePollsAssignmentSession

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

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

Moving or adding a reference of a Candidate to another Polls is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignCandidates

      boolean canAssignCandidates()
      Tests if this user can alter candidate/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 assignment operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canAssignCandidatesToPolls

      boolean canAssignCandidatesToPolls(Id pollsId)
      Tests if this user can alter candidate/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 assignment 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 candidate 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.

    • getAssignablePollsIdsForCandidate

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

    • assignCandidateToPolls

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

    • unassignCandidateFromPolls

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

    • reassignCandidateToPolls

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