Interface AuditProcessorLookupSession

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

This session provides methods for retrieving AuditProcessors .

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 audit processor methods in this session operate, retrieve and pertain to audit processors defined explicitly in the current inquest Using an isolated view is useful for managing AuditProcessors with the AuditProcessorAdminSession .
  • federated inquest view: All audit processor methods in this session operate, retrieve and pertain to all audit processors defined in this inquest and any other audit processors implicitly available in this inquest through inquest 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 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.

    • canLookupAuditProcessors

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

    • useComparativeAuditProcessorView

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

    • usePlenaryAuditProcessorView

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

    • getAuditProcessor

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

    • getAuditProcessorsByIds

      AuditProcessorList getAuditProcessorsByIds(IdList auditProcessorIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an AuditProcessorList corresponding to the given IdList . In plenary mode, the returned list contains all of the audit 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 AuditProcessors may be om itted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      auditProcessorIds - the list of Ids to retrieve
      Returns:
      the returned AuditProcessor list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - auditProcessorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuditProcessorsByGenusType

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

    • getAuditProcessorsByParentGenusType

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

    • getAuditProcessorsByRecordType

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

    • getAuditProcessors

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