Interface QualifierLookupSession

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

This session defines methods for retrieving qualifiers.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated vault view: All qualifier methods in this session operate, retrieve and pertain to qualifiers defined explicitly in the current vault. Using an isolated view is useful for managing Qualifiers with the QualifierAdminSession .
  • federated vault view: All qualifier methods in this session operate, retrieve and pertain to all qualifiers defined in this vault and any other qualifiers implicitly available in this vault through vault inheritence.

The methods useFederatedVaultView() and useIsolatedVaultView() behave as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getVaultId

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

    • getVault

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

    • canLookupQualifiers

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

    • useComparativeQualifierView

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

    • usePlenaryQualifierView

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

    • useFederatedVaultView

      void useFederatedVaultView()
      Federates the view for methods in this session. A federated view will include qualifiers in vaults which are children of this vault in the vault hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedVaultView

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

    • getQualifier

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

    • getQualifiersByIds

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

    • getQualifiersByGenusType

      QualifierList getQualifiersByGenusType(Type qualifierGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a QualifierList corresponding to the given qualifier genus Type which does not include qualifiers of types derived from the specified Type .In plenary mode, the returned list contains all known qualifiers or an error results. Otherwise, the returned list may contain only those qualifiers that are accessible through this session. In both cases, the order of the set is not specified.
      Parameters:
      qualifierGenusType - a qualifier genus type
      Returns:
      the returned Qualifier list
      Throws:
      NullArgumentException - qualifierGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQualifiersByParentGenusType

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

    • getQualifiersByRecordType

      QualifierList getQualifiersByRecordType(Type qualifierRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a QualifierList corresponding to the given qualifier record Type .The set of qualifiers implementing the given record type is returned. In plenary mode, the returned list contains all known qualifiers or an error results. Otherwise, the returned list may contain only those qualifiers that are accessible through this session.
      Parameters:
      qualifierRecordType - a qualifier record type
      Returns:
      the returned Qualifier list
      Throws:
      NullArgumentException - qualifierRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQualifiers

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