Interface InquiryLookupSession

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

This session provides methods for retrieving Inquiries . The Inquiry represents a fixed connection between two Inquiries .

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 inquest view: All inquiry methods in this session operate, retrieve and pertain to inquiries defined explicitly in the current inquest. Using an isolated view is useful for managing Inquiries with the InquiryAdminSession .
  • federated inquest view: All inquiry methods in this session operate, retrieve and pertain to all inquiries defined in this inquest and any other inquiries implicitly available in this inquest through inquest inheritence.
  • active inquiry view: active inquiries are returned from methods in this session
  • any status inquiry view: active and inactive inquiries are returned from methods in this session

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 useFederatedInquestView() and useIsolatedInquestView() behave as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getInquestId

      Id getInquestId()
      Gets the Inquest Id associated with this session.
      Returns:
      the Inquest Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getInquest

      Inquest getInquest() throws OperationFailedException, PermissionDeniedException
      Gets the Inquest associated with this session.
      Returns:
      the inquest
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupInquiries

      boolean canLookupInquiries()
      Tests if this user can perform Inquiry 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.

    • useComparativeInquiryView

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

    • usePlenaryInquiryView

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

    • useFederatedInquestView

      void useFederatedInquestView()
      Federates the view for methods in this session. A federated view will include inquiries in inquests which are children of this inquest in the inquest hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedInquestView

      void useIsolatedInquestView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this inquest only.
      Compliance:
      mandatory - This method is must be implemented.

    • useActiveInquiryView

      void useActiveInquiryView()
      Only active inquiries are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusInquiryView

      void useAnyStatusInquiryView()
      All inquiries of any active or inactive status are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getInquiry

      Inquiry getInquiry(Id inquiryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Inquiry specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Inquiry may have a different Id than requested, such as the case where a duplicate Id was assigned to an Inquiry and retained for compatibility. In active mode, inquiries are returned that are currently active. In any status mode, both active and inactive inquiries are returned.
      Parameters:
      inquiryId - Id of the Inquiry
      Returns:
      the inquiry
      Throws:
      NotFoundException - inquiryId not found
      NullArgumentException - inquiryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getInquiriesByIds

      InquiryList getInquiriesByIds(IdList inquiryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an InquiryList corresponding to the given IdList . In plenary mode, the returned list contains all of the inquiries 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 Inquiries may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, inquiries are returned that are currently active. In any status mode, both active and inactive inquiries are returned.
      Parameters:
      inquiryIds - the list of Ids to retrieve
      Returns:
      the returned Inquiry list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - inquiryIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getInquiriesByGenusType

      InquiryList getInquiriesByGenusType(Type inquiryGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an InquiryList corresponding to the given inquiry genus Type which does not include inquiries of genus types derived from the specified Type . In plenary mode, the returned list contains all known inquiries or an error results. Otherwise, the returned list may contain only those inquiries that are accessible through this session. In active mode, inquiries are returned that are currently active. In any status mode, both active and inactive inquiries are returned.
      Parameters:
      inquiryGenusType - an inquiry genus type
      Returns:
      the returned Inquiry list
      Throws:
      NullArgumentException - inquiryGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getInquiriesByParentGenusType

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

    • getInquiriesByRecordType

      InquiryList getInquiriesByRecordType(Type inquiryRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an InquiryList containing the given inquiry record Type . In plenary mode, the returned list contains all known inquiries or an error results. Otherwise, the returned list may contain only those inquiries that are accessible through this session. In active mode, inquiries are returned that are currently active. In any status mode, both active and inactive inquiries are returned.
      Parameters:
      inquiryRecordType - an inquiry record type
      Returns:
      the returned Inquiry list
      Throws:
      NullArgumentException - inquiryRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getInquiriesForAudit

      InquiryList getInquiriesForAudit(Id auditId) throws OperationFailedException, PermissionDeniedException
      Gets a list of inquiries for a supplied audit. In plenary mode, the returned list contains all known inquiries or an error results. Otherwise, the returned list may contain only those inquiries that are accessible through this session. In active mode, inquiries are returned that are currently active. In any status mode, both active and inactive inquiries are returned.
      Parameters:
      auditId - an audit Id
      Returns:
      the returned Inquiry list
      Throws:
      NullArgumentException - auditId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getInquiries

      InquiryList getInquiries() throws OperationFailedException, PermissionDeniedException
      Gets all Inquiries . In plenary mode, the returned list contains all known inquiries or an error results. Otherwise, the returned list may contain only those inquiries that are accessible through this session. In active mode, inquiries are returned that are currently active. In any status mode, both active and inactive inquiries are returned.
      Returns:
      a list of Inquiries
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.