Interface IssueProcessorEnablerOublietteSession

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

This session provides methods to retrieve IssueprocessorEnabler to Oubliette mappings. An IssueProcessorEnabler may appear in multiple Oubliettes. Each oub liette may have its own authorizations governing who is allowed to look at it.

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

  • Method Details

    • canLookupIssueProcessorEnablerOublietteMappings

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

    • useComparativeIssueProcessorEnablerOublietteView

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

    • usePlenaryIssueProcessorEnablerOublietteView

      void usePlenaryIssueProcessorEnablerOublietteView()
      A complete view of the IssueProcessorEnabler and Oubliette 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.

    • getIssueProcessorEnablerIdsByOubliette

      IdList getIssueProcessorEnablerIdsByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of IssueProcessorEnablerIds associated with an Oubliette .
      Parameters:
      oublietteId - Id of the Oubliette
      Returns:
      list of related issue processor enabler Ids
      Throws:
      NotFoundException - oublietteId is not found
      NullArgumentException - oublietteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorEnablersByOubliette

      IssueProcessorEnablerList getIssueProcessorEnablersByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of IssueProcessorEnablers associated with an Oubliette .
      Parameters:
      oublietteId - Id of the Oubliette
      Returns:
      list of related issue processor enablers
      Throws:
      NotFoundException - oublietteId is not found
      NullArgumentException - oublietteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorEnablerIdsByOubliettes

      IdList getIssueProcessorEnablerIdsByOubliettes(IdList oublietteIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of IssueProcessorEnablerIds corresponding to a list of Oubliettes .
      Parameters:
      oublietteIds - list of oubliette Ids
      Returns:
      list of issue processor enabler Ids
      Throws:
      NullArgumentException - oublietteIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorEnablersByOubliettes

      IssueProcessorEnablerList getIssueProcessorEnablersByOubliettes(IdList oublietteIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of IssueProcessorEnablers corresponding to a list of Oubliettes .
      Parameters:
      oublietteIds - list of oubliette Ids
      Returns:
      list of issue processor enablers
      Throws:
      NullArgumentException - oublietteIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getOublietteIdsByIssueProcessorEnabler

      IdList getOublietteIdsByIssueProcessorEnabler(Id issueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Oubliette Ids mapped to an IssueProcessorEnabler .
      Parameters:
      issueProcessorEnablerId - Id of an IssueProcessorEnabler
      Returns:
      list of oubliette 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.

    • getOubliettesByIssueProcessorEnabler

      OublietteList getOubliettesByIssueProcessorEnabler(Id issueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Oubliettes mapped to an IssueProcessorEnabler .
      Parameters:
      issueProcessorEnablerId - Id of an IssueProcessorEnabler
      Returns:
      list of oubliettes
      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.