Interface IssueProcessorLookupSession

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

This session provides methods for retrieving IssueProcessors .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated oubliette view: All issue processor methods in this session operate, retrieve and pertain to issue processors defined explicitly in the current oubliette Using an isolated view is useful for managing IssueProcessors with the IssueProcessorAdminSession .
  • federated issue processor view: All issue processor methods in this session operate, retrieve and pertain to all issue processors defined in this oubliette and any other issue processors implicitly available in this oubliette through oubliette inheritence.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedOublietteView() and useIsolatedOublietteView() beha ve as a radio group and one should be selected before invoking any lookup methods.

  • 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.

    • canLookupIssueProcessors

      boolean canLookupIssueProcessors()
      Tests if this user can perform IssueProcessor lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeIssueProcessorView

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

    • usePlenaryIssueProcessorView

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

    • getIssueProcessor

      IssueProcessor getIssueProcessor(Id issueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the IssueProcessor specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned IssueProcessor may have a different Id than requested, such as the case where a duplicate Id was assigned to an IssueProcessor and retained for compatibility.
      Parameters:
      issueProcessorId - Id of the IssueProcessor
      Returns:
      the issue processor
      Throws:
      NotFoundException - issueProcessorId not found
      NullArgumentException - issueProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getIssueProcessorsByIds

      IssueProcessorList getIssueProcessorsByIds(IdList issueProcessorIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an IssueProcessorList corresponding to the given IdList . In plenary mode, the returned list contains all of the issue processors specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible IssueProcessors m ay be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      issueProcessorIds - the list of Ids to retrieve
      Returns:
      the returned IssueProcessor list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - issueProcessorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorsByGenusType

      IssueProcessorList getIssueProcessorsByGenusType(Type issueProcessorGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an IssueProcessorList corresponding to the given issue processor genus Type which does not include issue processors of genus types derived from the specified Type . In plenary mode, the returned list contains all known issue processors or an error results. Otherwise, the returned list may contain only those issue processors that are accessible through this session.
      Parameters:
      issueProcessorGenusType - an issue processor genus type
      Returns:
      the returned IssueProcessor list
      Throws:
      NullArgumentException - issueProcessorGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorsByParentGenusType

      IssueProcessorList getIssueProcessorsByParentGenusType(Type issueProcessorGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an IssueProcessorList corresponding to the given issue processor genus Type and include any additional issue processors with genus types derived from the specified Type . In plenary mode, the returned list contains all known issue processors or an error results. Otherwise, the returned list may contain only those issue processors that are accessible through this session.
      Parameters:
      issueProcessorGenusType - an issue processor genus type
      Returns:
      the returned IssueProcessor list
      Throws:
      NullArgumentException - issueProcessorGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorsByRecordType

      IssueProcessorList getIssueProcessorsByRecordType(Type issueProcessorRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an IssueProcessorList containing the given issue processor record Type . In plenary mode, the returned list contains all known issue processors or an error results. Otherwise, the returned list may contain only those issue processors that are accessible through this session.
      Parameters:
      issueProcessorRecordType - an issue processor record type
      Returns:
      the returned IssueProcessor list
      Throws:
      NullArgumentException - issueProcessorRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessors

      IssueProcessorList getIssueProcessors() throws OperationFailedException, PermissionDeniedException
      Gets all IssueProcessors . In plenary mode, the returned list contains all known issue processors or an error results. Otherwise, the returned list may contain only those issue processors that are accessible through this session.
      Returns:
      a list of IssueProcessors
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.