Interface AuditConstrainerEnablerLookupSession

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

This session provides methods for retrieving AuditConstrainerEnablers .

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

    • canLookupAuditConstrainerEnablers

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

    • useComparativeAuditConstrainerEnablerView

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

    • usePlenaryAuditConstrainerEnablerView

      void usePlenaryAuditConstrainerEnablerView()
      A complete view of the AuditConstrainerEnabler 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 constrainer 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.

    • getAuditConstrainerEnabler

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

    • getAuditConstrainerEnablersByIds

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

    • getAuditConstrainerEnablersByGenusType

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

    • getAuditConstrainerEnablersByParentGenusType

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

    • getAuditConstrainerEnablersByRecordType

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

    • getAuditConstrainerEnablers

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