Interface IssueProcessorRuleLookupSession

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

This session provides methods to retrieve IssueProcessor to Issue mappings.

Th is lookup session defines several views:
  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated oubliette view: All methods in this session operate, retrieve and pertain to issue processoras defined explicitly in the current oubliette
  • federated oubliette view: All methods in this session operate, retrieve and pertain to all issue processors defined in this oubliette and any other issue processors implicitly available in this oubliette through oubliette inheritence.

  • Method Details

    • getOublietteId

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

    • getOubliette

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

    • canLookupIssueProcessorRules

      boolean canLookupIssueProcessorRules()
      Tests if this user can perform lookups of issue processor/issue mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeIssueProcessorRuleView

      void useComparativeIssueProcessorRuleView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryIssueProcessorRuleView

      void usePlenaryIssueProcessorRuleView()
      A complete view of the IssueProcessor and Issue returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedOublietteView

      void useFederatedOublietteView()
      Federates the view for methods in this session. A federated view will include issue processors in oubliettes which are children of this oubliette in the oubliette hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedOublietteView

      void useIsolatedOublietteView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this oubliette only.
      Compliance:
      mandatory - This method is must be implemented.

    • getIssueProcessorIdsForIssue

      IdList getIssueProcessorIdsForIssue(Id issueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the IssueProcessor Ids associated with an Issue .
      Parameters:
      issueId - Id of the Issue
      Returns:
      the issue processor Ids
      Throws:
      NotFoundException - issueId is not found
      NullArgumentException - issueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorsForIssue

      IssueProcessorList getIssueProcessorsForIssue(Id issueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the IssueProcessors associated with an Issue .
      Parameters:
      issueId - Id of the Issue
      Returns:
      the issue processors
      Throws:
      NotFoundException - issueId is not found
      NullArgumentException - issueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueIdsForIssueProcessor

      IdList getIssueIdsForIssueProcessor(Id issueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Issue Ids mapped to an IssueProcessor .
      Parameters:
      issueProcessorId - Id of an IssueProcessor
      Returns:
      list of issue Ids
      Throws:
      NotFoundException - issueProcessorId is not found
      NullArgumentException - issueProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssuesForIssueProcessor

      IssueList getIssuesForIssueProcessor(Id issueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Issues mapped to an IssueProcessor .
      Parameters:
      issueProcessorId - Id of an IssueProcessor
      Returns:
      list of issues
      Throws:
      NotFoundException - issueProcessorId is not found
      NullArgumentException - issueProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.