Interface InstallationPackageLookupSession

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

This session provides methods for retrieving InstallationPackages from remote Depots.

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 depot view: All package methods in this session operate, retrieve and pertain to packages defined explicitly in the current depot. Using an isolated view is useful for managing packages with the InstallationPackageAdminSession.
  • federated depot view: All package methods in this session operate, retrieve and pertain to all packages defined in this depot and any other depots implicitly available in this depot through depot inheritence.
  • normalized version view: multiple versions of the same package are suppressed
  • denormalized version vew: all versions of an installation are returned

InstallationPackages may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the InstallationPackage.

  • Method Details

    • getDepotId

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

    • getDepot

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

    • canLookupInstallationPackages

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

    • useComparativeInstallationPackageView

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

    • usePlenaryInstallationPackageView

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

    • useFederatedDepotView

      void useFederatedDepotView()
      Federates the view for methods in this session. A federated view will include packages in depots which are children of this depot in the depot hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedDepotView

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

    • useNormalizedVersionView

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

    • useDenormalizedVersionView

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

    • getInstallationPackage

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

    • getInstallationPackagesByIds

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

    • getInstallationPackagesByGenusType

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

    • getInstallationPackagesByParentGenusType

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

    • getInstallationPackagesByRecordType

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

    • getInstallationPackagesByProvider

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

    • getDependentInstallationPackages

      InstallationPackageList getDependentInstallationPackages(Id installationPackageId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a list of packages depending on the given package.
      Parameters:
      installationPackageId - an Id of a InstallationPackage
      Returns:
      list of package dependents
      Throws:
      NotFoundException - installationPackageId is not found
      NullArgumentException - installationPackageId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getInstallationPackageVersions

      InstallationPackageList getInstallationPackageVersions(Id installationPackageId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a list of packages in the specified package version chain.
      Parameters:
      installationPackageId - an Id of a InstallationPackage
      Returns:
      list of dependencies
      Throws:
      NotFoundException - installationPackageId is not found
      NullArgumentException - installationPackageId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getInstallationPackages

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