Interface IssueEnablerRuleLookupSession

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

This session provides methods to retrieve IssueEnabler 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 enablers defined explicitly in the current oubliette
  • federated oubliette view: All methods in this session operate, retrieve and pertain to all issue enablers defined in this oubliette and any other issue enablers 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.

    • canLookupIssueEnablerRules

      boolean canLookupIssueEnablerRules()
      Tests if this user can perform lookups of issue enabler/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.

    • useComparativeIssueEnablerRuleView

      void useComparativeIssueEnablerRuleView()
      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.

    • usePlenaryIssueEnablerRuleView

      void usePlenaryIssueEnablerRuleView()
      A complete view of the IssueEnabler 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 enablers 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.

    • getIssueEnablerIdsForIssue

      IdList getIssueEnablerIdsForIssue(Id issueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the IssueEnabler Ids associated with an Issue .
      Parameters:
      issueId - Id of the Issue
      Returns:
      the issue enabler 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.

    • getIssueEnablersForIssue

      IssueEnablerList getIssueEnablersForIssue(Id issueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the IssueEnablers associated with an Issue .
      Parameters:
      issueId - Id of the Issue
      Returns:
      the issue enablers
      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.

    • getIssueIdsForIssueEnabler

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

    • getIssuesForIssueEnabler

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