Interface ModelLookupSession

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

This session defines methods for retrieving models.

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 warehouse view: All model methods in this session operate, retrieve and pertain to models defined explicitly in the current warehouse. Using an isolated view is useful for managing Models with the ModelAdminSession .
  • federated warehouse view: All model lookup methods in this session operate, retrieve and pertain to all models defined in this warehouse and any other models implicitly available in this warehouse through warehouse inheritence.

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

  • Method Details

    • getWarehouseId

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

    • getWarehouse

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

    • canLookupModels

      boolean canLookupModels()
      Tests if this user can perform Model 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 not offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeModelView

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

    • usePlenaryModelView

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

    • useFederatedWarehouseView

      void useFederatedWarehouseView()
      Federates the view for methods in this session. A federated view will include models in catalogs which are children of this catalog in the warehouse hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedWarehouseView

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

    • getModel

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

    • getModelsByIds

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

    • getModelsByGenusType

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

    • getModelsByParentGenusType

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

    • getModelsByRecordType

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

    • getModelsByManufacturer

      ModelList getModelsByManufacturer(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a ModelList for the given resource Id . In plenary mode, the returned list contains all known models or an error results. Otherwise, the returned list may contain only those models that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Model list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getModels

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