Interface IssueProcessorOublietteSession

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

This session provides methods to retrieve IssueProcessor to Oubliette mappings. An IssueProcessor may appear in multiple Oubliettes . Each oubliette 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

    • canLookupIssueProcessorOublietteMappings

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

    • useComparativeIssueProcessorOublietteView

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

    • usePlenaryIssueProcessorOublietteView

      void usePlenaryIssueProcessorOublietteView()
      A complete view of the IssueProcessor 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.

    • getIssueProcessorIdsByOubliette

      IdList getIssueProcessorIdsByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of IssueProcessorIds associated with an Oubliette .
      Parameters:
      oublietteId - Id of the Oubliette
      Returns:
      list of related issue processor 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.

    • getIssueProcessorsByOubliette

      IssueProcessorList getIssueProcessorsByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of IssueProcessors associated with an Oubliette .
      Parameters:
      oublietteId - Id of the Oubliette
      Returns:
      list of related issue processors
      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.

    • getIssueProcessorIdsByOubliettes

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

    • getIssueProcessorsByOubliettes

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

    • getOublietteIdsByIssueProcessor

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

    • getOubliettesByIssueProcessor

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