org.osid.installation

Interface Summary
Interface	Description
Depot	A depot defines a collection of packages.
DepotAdminSession	This session creates, updates, and deletes `Depots.`
DepotForm	This is the form for creating and updating depots.
DepotHierarchyDesignSession	This session defines methods for managing a hierarchy of `Depot` objects.
DepotHierarchySession	This session defines methods for traversing a hierarchy of `Depot` objects.
DepotList	Like all `OsidLists,` `DepotList` provides a means for accessing `Depot` elements sequentially either one at a time or many at a time.
DepotLookupSession	This session provides methods for retrieving `Depot` objects.
DepotNode	This interface is a container for a partial hierarchy retrieval.
DepotNodeList	Like all `OsidLists,` `DepotNodeList` provides a means for accessing `DepotNode` elements sequentially either one at a time or many at a time.
DepotNotificationSession	This session defines methods to receive notifications on adds/changes to `Depot` objects.
DepotQuery	This is the query for searching depots.
DepotQueryInspector	This is the query inspector for examining depot queries.
DepotQuerySession	This session provides methods for searching among `Depot` objects.
DepotReceiver	The vault receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Depot` objects.
DepotSearch	The interface for governing depot searches.
DepotSearchOrder	An interface for specifying the ordering of search results.
DepotSearchResults	This interface provides a means to capture results of a search.
DepotSearchSession	This session provides methods for searching among `Depot` objects.
Installation	A `Installation` represents a `Package` installed on a `Site.`
InstallationContent	An installation content contains information about the installation data.
InstallationContentForm	This is the form for creating and updating `InstallationContents.`
InstallationContentList	Like all `OsidLists,` `InstallationContentList` provides a means for accessing `InstallationContent` elements sequentially either one at a time or many at a time.
InstallationContentQuery	This is the query for searching installation contents.
InstallationContentQueryInspector	This is the query inspector for examining installation content queries.
InstallationList	Like all `OsidLists,` `InstallationList` provides a means for accessing `Installation` elements sequentially either one at a time or many at a time.
InstallationLookupSession	The session defines methods for retrieving `Installations` from installation `Sites.`
InstallationManagementSession	This session defines methods to manage installations.
InstallationManager	The installation manager provides access to package installation sessions and provides interoperability tests for various aspects of this service.
InstallationNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to `Installation` objects.
InstallationProfile	The `InstallationProfile` describes the interoperability among installation services.
InstallationProxyManager	The installation manager provides access to package installation sessions and provides interoperability tests for various aspects of this service.
InstallationQuery	This is the query for searching installations.
InstallationQueryInspector	This is the query inspector for examining installation queries.
InstallationQuerySession	This session provides methods for searching `Installations.`
InstallationReceiver	The installation receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Installations.`
InstallationSearch	`InstallationSearch` defines the interface for specifying installation search options.
InstallationSearchOrder	An interface for specifying the ordering of search results.
InstallationSearchResults	This interface provides a means to capture results of a search.
InstallationSearchSession	This session provides methods for searching `Installations.`
InstallationUpdateSession	This session defines methods to manage installations.
Package	A `Package` represents an installation bundle in a depot.
PackageAdminSession	This session creates, updates, and deletes `Packages.`
PackageDepotAssignmentSession	This session provides methods to re-assign `Packages` to `Depots.`
PackageDepotSession	This session provides methods to retrieve `Package` to `Depot` mappings.
PackageForm	This is the form for creating and updating `Packages.`
PackageList	Like all `OsidLists,` `PackageList` provides a means for accessing `Package` elements sequentially either one at a time or many at a time.
PackageLookupSession	This session provides methods for retrieving `Package` s from remote `Depots.`
PackageNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to `Package` objects.
PackageQuery	This is the query for searching packages.
PackageQueryInspector	This is the query inspector for examining package queries.
PackageQuerySession	This session provides methods for searching `Package` objects.
PackageReceiver	The package receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Packages.`
PackageSearch	`PackageSearch` defines the interface for specifying package search options.
PackageSearchOrder	An interface for specifying the ordering of search results.
PackageSearchResults	This interface provides a means to capture results of a search.
PackageSearchSession	This session provides methods for searching `Package` objects.
PackageSmartDepotSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Site	A `Site` represents an installation location.
SiteList	Like all `OsidLists,` `SiteList` provides a means for accessing `Site` elements sequentially either one at a time or many at a time.
SiteLookupSession	This session provides methods for retrieving `Site` objects.
SiteQuery	This is the query for searching installations.
SiteQueryInspector	This is the query inspector for examining installations queries.
SiteSearchOrder	An interface for specifying the ordering of search results.
Version	A `Version` represents a version in a scheme.

Package org.osid.installation Description

The Open Service Interface Definitions for the org.osid.installation service.

The Installation OSID describes two categories of services. One service is to find, retrieve and manage installation packages in remote repositories, or Depots. The other service is to manage installations (downloaded packages) on Sites. Sites are generally, but not required to be, on local disk.

Packages

Packages define a set of core data and map to an independently retrieved and managed data stream. The data stream may be an archive file of a certain format. A Package may include multiple formats. Packages also may have other packages on which it depends for operation. Each version of a software package is a separate Package identified by a separate Id. Version chains may be defined to communicate newer available versions.

Installations

An installed package on a Site is an Installation. Installations are similar to Packages with a different set of core data and no access to the archive stream. Installations may also have dependencies and versioning.

Methods are defined to check for updates available in a Depot for an Installation, at which time the consumer may elect to install the new Package Id for the updated version. Depending on whether a provider keeps the older version around, delete operations may be available for outdated versions and allow for dependency management across versions.

Sites are assumed to be fixed to the runtime environment and are not manageable through the Installation OSID. As such, Sites are not modeled as OsidCatalogs and a single Installation may belong to only one Site.

Depot Cataloging

Packages are organized into Depots for categorization and federation using the OSID hierarchy pattern. Dynamic virtual Depots may be created by filtering on various Package attributes.

Versions

The Installation OSID defines an OsidPrimitive for a Version. A Version describes a version number.

Orchestration

The Installation OSID may be orchestrated with a Configuration OSID to retrieve or manage installation configurations.

Sub Packages

The Installation OSID contains an Installation Batch OSID for managing Packages and Installations in bulk.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may modify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.