Interface IssueConstrainerEnablerRuleLookupSession

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

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

    • canLookupIssueConstrainerEnablerRules

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

    • useComparativeIssueConstrainerEnablerRuleView

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

    • usePlenaryIssueConstrainerEnablerRuleView

      void usePlenaryIssueConstrainerEnablerRuleView()
      A complete view of the IssueConstrainerEnabler and IssueConstrainer 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 constrainer 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.

    • getIssueConstrainerEnablerIdsForIssue

      IdList getIssueConstrainerEnablerIdsForIssue(Id issueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the IssueConstrainerEnablerIds associated with an IssueConstrainer .
      Parameters:
      issueConstrainerId - Id of the IssueConstrainer
      Returns:
      the issue constrainer enabler Ids
      Throws:
      NotFoundException - issueConstrainerId is not found
      NullArgumentException - issueConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainerEnablersForIssueConstrainer

      IssueConstrainerEnablerList getIssueConstrainerEnablersForIssueConstrainer(Id issueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the IssueConstrainerEnablers associated with an IssueConstrainer .
      Parameters:
      issueConstrainerId - Id of the IssueConstrainer
      Returns:
      the issue constrainer enablers
      Throws:
      NotFoundException - issueConstrainerId is not found
      NullArgumentException - issueConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainerIdsForIssueConstrainerEnabler

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

    • getIssueConstrainersForIssueConstrainerEnabler

      IssueConstrainerList getIssueConstrainersForIssueConstrainerEnabler(Id issueConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the IssueConstrainers mapped to an IssueConstrainerEnabler .
      Parameters:
      issueConstrainerEnablerId - Id of an IssueConstrainerEnabler
      Returns:
      list of issue constrainers
      Throws:
      NotFoundException - issueConstrainerEnablerId is not found
      NullArgumentException - issueConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.