Interface IssueProcessorEnablerRuleLookupSession

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

This session provides methods to retrieve IssueProcessorEnabler to IssueProcessor mappings .

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

    • canLookupIssueProcessorEnablerRules

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

    • useComparativeIssueProcessorEnablerRuleView

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

    • usePlenaryIssueProcessorEnablerRuleView

      void usePlenaryIssueProcessorEnablerRuleView()
      A complete view of the IssueProcessorEnabler and IssueProcessor 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 processor 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.

    • getIssueProcessorEnablerIdsForIssue

      IdList getIssueProcessorEnablerIdsForIssue(Id issueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the IssueProcessorEnabler Ids associated with an IssueProcessor .
      Parameters:
      issueProcessorId - Id of the IssueProcessor
      Returns:
      the issue processor enabler 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.

    • getIssueProcessorEnablersForIssueProcessor

      IssueProcessorEnablerList getIssueProcessorEnablersForIssueProcessor(Id issueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the IssueProcessorEnablers associated with an IssueProcessor .
      Parameters:
      issueProcessorId - Id of the IssueProcessor
      Returns:
      the issue processor enablers
      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.

    • getIssueProcessorIdsForIssueProcessorEnabler

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

    • getIssueProcessorsForIssueProcessorEnabler

      IssueProcessorList getIssueProcessorsForIssueProcessorEnabler(Id issueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the IssueProcessors mapped to an IssueProcessorEnabler .
      Parameters:
      issueProcessorEnablerId - Id of an IssueprocessorEnabler
      Returns:
      list of issue processors
      Throws:
      NotFoundException - issueProcessorEnablerId is not found
      NullArgumentException - issueProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.