Interface AuditProcessorEnablerLookupSession

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

This session provides methods for retrieving AuditProcessorEnablers .

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

    • canLookupAuditProcessorEnablers

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

    • useComparativeAuditProcessorEnablerView

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

    • usePlenaryAuditProcessorEnablerView

      void usePlenaryAuditProcessorEnablerView()
      A complete view of the AuditProcessorEnabler 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 processor enablers 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.

    • getAuditProcessorEnabler

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

    • getAuditProcessorEnablersByIds

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

    • getAuditProcessorEnablersByGenusType

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

    • getAuditProcessorEnablersByParentGenusType

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

    • getAuditProcessorEnablersByRecordType

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

    • getAuditProcessorEnablers

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