Interface InstallationQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
InstallationSearchSession
public interface InstallationQuerySession extends OsidSession

This session provides methods for searching Installations. The search query is constructed using the InstallationQuery. The installation record Type also specifies the record for the installation query.

Installations may have a query record indicated by their respective record types. The query record is accessed via the InstallationQuery.

  • Method Details

    • getSiteId

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

    • getSite

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

    • canSearchInstallations

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

    • useNormalizedVersionView

      void useNormalizedVersionView()
      The returns from the lookup methods may omit multiple versions of the same installation.
      Compliance:
      mandatory - This method is must be implemented.

    • useDenormalizedVersionView

      void useDenormalizedVersionView()
      All versions of the same installation are returned.
      Compliance:
      mandatory - This method is must be implemented.

    • useNormalizedDependencyView

      void useNormalizedDependencyView()
      A normalized view uses a single Installation to represent a set of package dependencies.
      Compliance:
      mandatory - This method is must be implemented.

    • useDenormalizedDependencyView

      void useDenormalizedDependencyView()
      A denormalized view returns all dependencies.
      Compliance:
      mandatory - This method is must be implemented.

    • getInstallationQuery

      InstallationQuery getInstallationQuery()
      Gets an installation query.
      Returns:
      the installation query
      Compliance:
      mandatory - This method must be implemented.

    • getInstallationsByQuery

      InstallationList getInstallationsByQuery(InstallationQuery installationQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Installations matching the given installation query.
      Parameters:
      installationQuery - the installation query
      Returns:
      the returned InstallationList
      Throws:
      NullArgumentException - installationQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - installationQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.