Interface BlockingIssueAdminSession

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

This session blocks issues.

  • Method Details

    • getFrontOfficeId

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

    • getFrontOffice

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

    • canBlockIssues

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

    • canBlockIssue

      boolean canBlockIssue(Id issueId)
      Tests if this user can block an Issue . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating the subtask will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer blocking operations to an unauthorized user.
      Parameters:
      issueId - the Id of the Issue
      Returns:
      false if issue blocking is not authorized, true otherwise
      Throws:
      NullArgumentException - issueId is null
      Compliance:
      mandatory - This method must be implemented.
      Notes:
      If - the {@code issueId} is not found, then it is acceptable to return false to indicate the lack of create available.

    • blockIssue

      void blockIssue(Id blockedIssueId, Id blockingIssueId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Blocks an Issue .
      Parameters:
      blockedIssueId - the Id of the blocked Issue
      blockingIssueId - the Id of the blocking Issue
      Throws:
      AlreadyExistsException - blockingIssueId already blocking blockedIssueId
      NotFoundException - blockedIssueId or blockingIssueId not found
      NullArgumentException - blockedIssueId or blockingIssueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unblockIssue

      void unblockIssue(Id blockedIssueId, Id blockingIssueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Unblocks an Issue .
      Parameters:
      blockedIssueId - the Id of the blocked Issue
      blockingIssueId - the Id of the blocking Issue
      Throws:
      NotFoundException - blockedIssueId is not blocked by blockingIssueId
      NullArgumentException - blockedIssueId or blockingIssueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.