Interface AuditConstrainerLookupSession

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

This session provides methods for retrieving AuditConstrainers .

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

    • canLookupAuditConstrainers

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

    • useComparativeAuditConstrainerView

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

    • usePlenaryAuditConstrainerView

      void usePlenaryAuditConstrainerView()
      A complete view of the AuditConstrainer 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 constrainers 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.

    • getAuditConstrainer

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

    • getAuditConstrainersByIds

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

    • getAuditConstrainersByGenusType

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

    • getAuditConstrainersByParentGenusType

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

    • getAuditConstrainersByRecordType

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

    • getAuditConstrainers

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