OSID - osid.installation.InstallationManager Service Interface Definition

Interface	osid.installation.InstallationManager
Implements	`osid.OsidManager`
Implements	`osid.installation.InstallationProfile`
Used By	`osid.orchestration.OrchestrationManager`
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 `InstallationPackageLookupSession`: a session to look up packages `InstallationPackageQuerySession`: a session to query packages `InstallationPackageSearchSession`: a session to search packages `InstallationPackageAdminSession`: a session to create, modify and delete packages `InstallationPackageNotificationSession`: a session to receive messages pertaining to package changes `InstallationPackageDepotSession`: a session for retrieving package and depot mappings `InstallationPackageDepotAssignmentSession`: a session for managing package and depot mappings `InstallationPackageSmartDepotSession`: 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	getInstallationPackageLookupSession
Description	Gets the `OsidSession` associated with the package lookup service.
Return	`osid.installation.InstallationPackageLookupSession`		a `InstallationPackageLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInstallationPackageLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationPackageLookup()` is `true`.
Method	getInstallationPackageLookupSessionForDepot
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.InstallationPackageLookupSession`		`a InstallationPackageLookupSession`
Errors	NOT_FOUND		`depotId` not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsInstallationPackageLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationPackageLookup()` and `supportsVisibleFederation()` are `true`.
Method	getInstallationPackageQuerySession
Description	Gets the `OsidSession` associated with the package query service.
Return	`osid.installation.InstallationPackageQuerySession`		a `InstallationPackageQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInstallationPackageQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationPackageQuery()` is `true`.
Method	getInstallationPackageQuerySessionForDepot
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.InstallationPackageQuerySession`		a `InstallationPackageQuerySession`
Errors	NOT_FOUND		no `Depot` found by the given `Id`
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsInstallationPackageQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationPackageQuery()` and `supportsVisibleFederation()` are `true`
Method	getInstallationPackageSearchSession
Description	Gets the `OsidSession` associated with the package search service.
Return	`osid.installation.InstallationPackageSearchSession`		a `InstallationPackageSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInstallationPackageSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationPackageSearch()` is `true`.
Method	getInstallationPackageSearchSessionForDepot
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.InstallationPackageSearchSession`		`a InstallationPackageSearchSession`
Errors	NOT_FOUND		`depotId` not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsInstallationPackageSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationPackageSearch()` and `supportsVisibleFederation()` are `true`.
Method	getInstallationPackageAdminSession
Description	Gets the `OsidSession` associated with the package administration service.
Return	`osid.installation.InstallationPackageAdminSession`		a `InstallationPackageAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInstallationPackageAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationPackageAdmin()` is `true`.
Method	getInstallationPackageAdminSessionForDepot
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.InstallationPackageAdminSession`		`a InstallationPackageAdminSession`
Errors	NOT_FOUND		`depotId` not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsInstallationPackageAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationPackageAdmin()` and `supportsVisibleFederation()` are `true`.
Method	getInstallationPackageNotificationSession
Description	Gets the notification session for notifications pertaining to package changes.
Parameters	`osid.installation.InstallationPackageReceiver`	`installationPackageReceiver`	the package receiver
Return	`osid.installation.InstallationPackageNotificationSession`		a `InstallationPackageNotificationSession`
Errors	NULL_ARGUMENT		`installationPackageReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsInstallationPackageNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationPackageNotification()` is `true`.
Method	getInstallationPackageNotificationSessionForDepot
Description	Gets the `OsidSession` associated with the package notification service for the given depot.
Parameters	`osid.installation.InstallationPackageReceiver`	`installationPackageReceiver`	the package receiver
Parameters	`osid.id.Id`	`depotId`	the `Id` of the depot
Return	`osid.installation.InstallationPackageNotificationSession`		`a InstallationPackageNotificationSession`
Errors	NOT_FOUND		`depotId` not found
	NULL_ARGUMENT		`installationPackageReceiver` or `depotId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsInstallationPackageNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationPackageNotification()` and `supportsVisibleFederation()` are `true`.
Method	getInstallationPackageDepotSession
Description	Gets the session for retrieving package to depot mappings.
Return	`osid.installation.InstallationPackageDepotSession`		a `InstallationPackageDepotSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInstallationPackageDepot()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationPackageDepot()` is `true`.
Method	getInstallationPackageDepotAssignmentSession
Description	Gets the session for assigning package to depot mappings.
Return	`osid.installation.InstallationPackageDepotSession`		a `InstallationPackageDepotAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInstallationPackageDepotAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationPackageDepotAssignment()` is `true` .
Method	getInstallationPackageSmartDepotSession
Description	Gets the session for managing dynamic package depot.
Parameters	`osid.id.Id`	`depotId`	the `Id` of the depot
Return	`osid.installation.InstallationPackageSmartDepotSession`		a `InstallationPackageSmartDepotSession`
Errors	NOT_FOUND		`depotId` not found
	NULL_ARGUMENT		`depotId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsInstallationPackageSmartDepot()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInstallationPackageSmartDepot()` 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.