OSID - osid.installation.InstallationManager Service Interface Definition

Interface	osid.installation.InstallationManager
Implements	`osid.OsidManager`
Implements	`osid.installation.InstallationProfile`
Description	The installation manager provides access to package installation sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `InstallationLookupSession:` a session to look up local installations `InstallationQuerySession:` a session to query local installations `InstallationSearchSession:` a session to search local installations `InstallationManagementSession:` a session to install and remove packages `InstallationUpdateSession` : a session to get package updates `InstallationNotificationSession` a session for subscribing to new or deleted installations `SiteLookupSession:` a session for listing installation sites `PackageLookupSession:` a session to look up packages `PackageQuerySession:` a session to query packages `PackageSearchSession:` a session to search packages `PackageAdminSession:` a session to create, modify and delete packages `PackageNotificationSession: a` session to receive messages pertaining to package changes `PackageDepotSession:` a session for retrieving package and depot mappings `PackageDepotAssignmentSession:` a session for managing package and depot mappings `PackageSmartDepotSession:` a session for managing smart depots of packages `DepotLookupSession:` a session to lookup depots `DepotQuerySession:` a session to query depots `DepotSearchSession` : a session to search depots `DepotAdminSession` : a session to create, modify and delete depots `DepotNotificationSession` : a session to receive messages pertaining to depot changes `DepotHierarchySession:` a session to traverse the depot hierarchy `DepotHierarchyDesignSession:` a session to manage the depot hierarchy
Method	getInstallationLookupSession
Description	Gets the `OsidSession` associated with the installation lookup service.
Return	`osid.installation.InstallationLookupSession`		an `InstallationLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInstallationLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationLookup()` is `true.`
Method	getInstallationLookupSessionForSite
Description	Gets the `OsidSession` associated with the installation lookup service for the given site.
Parameters	`osid.id.Id`	`siteId`	the `Id` of the site
Return	`osid.installation.InstallationLookupSession`		`an InstallationLookupSession`
Errors	NOT_FOUND		`siteId` not found
	NULL_ARGUMENT		`siteId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsInstallationLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationLookup()` and `supportsVisibleFederation()` are `true.`
Method	getInstallationQuerySession
Description	Gets the `OsidSession` associated with the installation query service.
Return	`osid.installation.InstallationQuerySession[]`		an `InstallationQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInstallationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationQuery()` is `true.`
Method	getInstallationQuerySessionForSite
Description	Gets the `OsidSession` associated with the installation query service for the given site.
Parameters	`osid.id.Id`	`siteId`	the `Id` of the site
Return	`osid.installation.InstallationQuerySession[]`		`an InstallationQuerySession`
Errors	NOT_FOUND		`siteId` not found
	NULL_ARGUMENT		`siteId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsInstallationQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationQuery()` and `supportsVisibleFederation()` are `true.`
Method	getInstallationSearchSession
Description	Gets the `OsidSession` associated with the installation search service.
Return	`osid.installation.InstallationSearchSession`		an `InstallationSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInstallationSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationSearch()` is `true.`
Method	getInstallationSearchSessionForSite
Description	Gets the `OsidSession` associated with the installation search service for the given site.
Parameters	`osid.id.Id`	`siteId`	the `Id` of the site
Return	`osid.installation.InstallationSearchSession`		`an InstallationSearchSession`
Errors	NOT_FOUND		`siteId` not found
	NULL_ARGUMENT		`siteId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsInstallationSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationSearch()` and `supportsVisibleFederation()` are `true.`
Method	getInstallationManagementSession
Description	Gets the `OsidSession` associated with the installation management service.
Return	`osid.installation.InstallationManagementSession`		an `InstallationAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInstallationManagement()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationManagement()` is `true.`
Method	getInstallationManagementSessionForSite
Description	Gets the `OsidSession` associated with the installation management service for the given site.
Parameters	`osid.id.Id`	`siteId`	the `Id` of the site
Return	`osid.installation.InstallationManagementSession`		`an InstallationAdminSession`
Errors	NOT_FOUND		`siteId` not found
	NULL_ARGUMENT		`siteId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsInstallationManagement()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationManagement()` and `supportsVisibleFederation()` are `true.`
Method	getInstallationUpdateSession
Description	Gets the `OsidSession` associated with the installation update service.
Return	`osid.installation.InstallationUpdateSession`		an `InstallationAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInstallationUpdate()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationUpdate()` is `true.`
Method	getInstallationUpdateSessionForSite
Description	Gets the `OsidSession` associated with the installation update service for the given site.
Parameters	`osid.id.Id`	`siteId`	the `Id` of the site
Return	`osid.installation.InstallationUpdateSession`		`an InstallationUpdateSession`
Errors	NOT_FOUND		`siteId` not found
	NULL_ARGUMENT		`siteId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsInstallationUpdate()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationUpdate()` and `supportsVisibleFederation()` are `true.`
Method	getInstallationNotificationSession
Description	Gets the notification session for notifications pertaining to installation changes.
Parameters	`osid.installation.InstallationReceiver`	`installationReceiver`	the installation receiver
Return	`osid.installation.InstallationNotificationSession`		an `InstallationNotificationSession`
Errors	NULL_ARGUMENT		`installationReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsInstallationNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationNotification()` is `true.`
Method	getInstallationNotificationSessionForSite
Description	Gets the `OsidSession` associated with the installation notification service for the given site.
Parameters	`osid.installation.InstallationReceiver`	`installationReceiver`	the installation receiver
Parameters	`osid.id.Id`	`siteId`	the `Id` of the site
Return	`osid.installation.InstallationNotificationSession`		`an InstallationNotificationSession`
Errors	NOT_FOUND		`siteId` not found
	NULL_ARGUMENT		`installationReceiver` or `siteId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsInstallationNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationNotification()` and `supportsVisibleFederation()` are `true.`
Method	getSiteLookupSession
Description	Gets the `OsidSession` associated with the site lookup service.
Return	`osid.installation.SiteLookupSession`		a `SiteLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSiteLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSiteLookup()` is `true.`
Method	getPackageLookupSession
Description	Gets the `OsidSession` associated with the package lookup service.
Return	`osid.installation.PackageLookupSession`		a `PackageLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPackageLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageLookup()` is `true.`
Method	getPackageLookupSessionForDepot
Description	Gets the `OsidSession` associated with the package lookup service for the given depot.
Parameters	`osid.id.Id`	`depotId`	the `Id` of the depot
Return	`osid.installation.PackageLookupSession`		`a PackageLookupSession`
Errors	NOT_FOUND		`depotId` not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsPackageLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageLookup()` and `supportsVisibleFederation()` are `true.`
Method	getPackageQuerySession
Description	Gets the `OsidSession` associated with the package query service.
Return	`osid.installation.PackageQuerySession`		a `PackageQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPackageQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageQuery()` is `true.`
Method	getPackageQuerySessionForDepot
Description	Gets the `OsidSession` associated with the package query service for the given depot.
Parameters	`osid.id.Id`	`depotId`	the `Id` of the `Depot`
Return	`osid.installation.PackageQuerySession`		a `PackageQuerySession`
Errors	NOT_FOUND		no `Depot` found by the given `Id`
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPackageQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageQuery()` and `supportsVisibleFederation()` are `true`
Method	getPackageSearchSession
Description	Gets the `OsidSession` associated with the package search service.
Return	`osid.installation.PackageSearchSession`		a `PackageSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPackageSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageSearch()` is `true.`
Method	getPackageSearchSessionForDepot
Description	Gets the `OsidSession` associated with the package search service for the given depot.
Parameters	`osid.id.Id`	`depotId`	the `Id` of the depot
Return	`osid.installation.PackageSearchSession`		`a PackageSearchSession`
Errors	NOT_FOUND		`depotId` not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsPackageSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageSearch()` and `supportsVisibleFederation()` are `true.`
Method	getPackageAdminSession
Description	Gets the `OsidSession` associated with the package administration service.
Return	`osid.installation.PackageAdminSession`		a `PackageAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPackageAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageAdmin()` is `true.`
Method	getPackageAdminSessionForDepot
Description	Gets the `OsidSession` associated with the package admin service for the given depot.
Parameters	`osid.id.Id`	`depotId`	the `Id` of the depot
Return	`osid.installation.PackageAdminSession`		`a PackageAdminSession`
Errors	NOT_FOUND		`depotId` not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsPackageAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getPackageNotificationSession
Description	Gets the notification session for notifications pertaining to package changes.
Parameters	`osid.installation.PackageReceiver`	`packageReceiver`	the package receiver
Return	`osid.installation.PackageNotificationSession`		a `PackageNotificationSession`
Errors	NULL_ARGUMENT		`packageReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPackageNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageNotification()` is `true.`
Method	getPackageNotificationSessionForDepot
Description	Gets the `OsidSession` associated with the package notification service for the given depot.
Parameters	`osid.installation.PackageReceiver`	`packageReceiver`	the package receiver
Parameters	`osid.id.Id`	`depotId`	the `Id` of the depot
Return	`osid.installation.PackageNotificationSession`		`a PackageNotificationSession`
Errors	NOT_FOUND		`depotId` not found
	NULL_ARGUMENT		`packageReceiver` or `depotId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsPackageNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageNotification()` and `supportsVisibleFederation()` are `true.`
Method	getPackageDepotSession
Description	Gets the session for retrieving package to depot mappings.
Return	`osid.installation.PackageDepotSession`		a `PackageDepotSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPackageDepot()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageDepot()` is `true.`
Method	getPackageDepotAssignmentSession
Description	Gets the session for assigning package to depot mappings.
Return	`osid.installation.PackageDepotSession`		a `PackageDepotAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPackageDepotAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageDepotAssignment()` is `true.`
Method	getPackageSmartDepotSession
Description	Gets the session for managing dynamic package depot.
Parameters	`osid.id.Id`	`depotId`	the `Id` of the depot
Return	`osid.installation.PackageSmartDepotSession`		a `PackageSmartDepotSession`
Errors	NOT_FOUND		`depotId` not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPackageSmartDepot()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPackageSmartDepot()` is `true.`
Method	getDepotLookupSession
Description	Gets the OsidSession associated with the depot lookup service.
Return	`osid.installation.DepotLookupSession`		a `DepotLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDepotLookup() is false`
Compliance	`optional`		This method must be implemented if `supportsDepotLookup()` is true.
Method	getDepotQuerySession
Description	Gets the depot query session.
Return	`osid.installation.DepotQuerySession`		a `DepotQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDepotQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDepotQuery()` is `true.`
Method	getDepotSearchSession
Description	Gets the OsidSession associated with the depot search service.
Return	`osid.installation.DepotSearchSession`		a `DepotSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDepotSearch() is false`
Compliance	`optional`		This method must be implemented if `supportsDepotSearch()` is true.
Method	getDepotAdminSession
Description	Gets the OsidSession associated with the depot administration service.
Return	`osid.installation.DepotAdminSession`		a `DepotAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDepotAdmin() is false`
Compliance	`optional`		This method must be implemented if `supportsDepotAdmin()` is true.
Method	getDepotNotificationSession
Description	Gets the notification session for notifications pertaining to depot service changes.
Parameters	`osid.installation.DepotReceiver`	`depotReceiver`	the depot receiver
Return	`osid.installation.DepotNotificationSession`		a `DepotNotificationSession`
Errors	NULL_ARGUMENT		`depotReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDepotNotification() is false`
Compliance	`optional`		This method must be implemented if `supportsDepotNotification()` is true.
Method	getDepotHierarchySession
Description	Gets the session traversing depot hierarchies.
Return	`osid.installation.DepotHierarchySession`		a `DepotHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDepotHierarchy() is false`
Compliance	`optional`		This method must be implemented if `supportsDepotHierarchy()` is true.
Method	getDepotHierarchyDesignSession
Description	Gets the session designing depot hierarchies.
Return	`osid.installation.DepotHierarchyDesignSession`		a `DepotHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDepotHierarchyDesign() is false`
Compliance	`optional`		This method must be implemented if `supportsDepotHierarchyDesign()` is true.
Method	getInstallationBatchManager
Description	Gets an `InstallationBatchManager.`
Return	`osid.installation.batch.InstallationBatchManager`		an `InstallationBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInstallationBatch() is false`
Compliance	`optional`		This method must be implemented if `supportsInstallationBatch()` is true.