Interface | osid.installation.InstallationProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.installation.InstallationProfile | |||
Description |
The installation manager provides access to package
installation sessions and provides interoperability tests for
various aspects of this service. Methods in this manager
accept a
| ||
Method | getInstallationLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.InstallationLookupSession | an InstallationLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInstallationLookup() is false | ||
Compliance | optional | This method must be implemented if supportsInstallationLookup()
is true. | |
Method | getInstallationLookupSessionForSite | ||
Description |
Gets the | ||
Parameters | osid.id.Id | siteId | the Id of the site |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.InstallationLookupSession | an InstallationLookupSession | |
Errors | NOT_FOUND | siteId not found | |
NULL_ARGUMENT | siteId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.InstallationQuerySession[] | an InstallationQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInstallationQuery() is false | ||
Compliance | optional | This method must be implemented if supportsInstallationQuery()
is true. | |
Method | getInstallationQuerySessionForSite | ||
Description |
Gets the | ||
Parameters | osid.id.Id | siteId | the Id of the site |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.InstallationQuerySession[] | an InstallationQuerySession | |
Errors | NOT_FOUND | siteId not found | |
NULL_ARGUMENT | siteId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.InstallationSearchSession | an InstallationSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInstallationSearch() is false | ||
Compliance | optional | This method must be implemented if supportsInstallationSearch()
is true. | |
Method | getInstallationSearchSessionForSite | ||
Description |
Gets the | ||
Parameters | osid.id.Id | siteId | the Id of the site |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.InstallationSearchSession | an InstallationSearchSession | |
Errors | NOT_FOUND | siteId not found | |
NULL_ARGUMENT | siteId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.InstallationManagementSession | an InstallationAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInstallationManagement() is false | ||
Compliance | optional | This method must be implemented if supportsInstallationManagement()
is true. | |
Method | getInstallationManagementSessionForSite | ||
Description |
Gets the | ||
Parameters | osid.id.Id | siteId | the Id of the site |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.InstallationManagementSession | an InstallationAdminSession | |
Errors | NOT_FOUND | siteId not found | |
NULL_ARGUMENT | siteId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.InstallationUpdateSession | an InstallationAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInstallationUpdate() is false | ||
Compliance | optional | This method must be implemented if supportsInstallationUpdate()
is true. | |
Method | getInstallationUpdateSessionForSite | ||
Description |
Gets the | ||
Parameters | osid.id.Id | siteId | the Id of the site |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.InstallationUpdateSession | an InstallationUpdateSession | |
Errors | NOT_FOUND | siteId not found | |
NULL_ARGUMENT | siteId or proxy 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 |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.InstallationNotificationSession | an InstallationNotificationSession | |
Errors | NULL_ARGUMENT | installationReceiver or proxy 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 | ||
Parameters | osid.installation.InstallationReceiver | installationReceiver | the installation receiver |
osid.id.Id | siteId | the Id of the site | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.InstallationNotificationSession | an InstallationNotificationSession | |
Errors | NOT_FOUND | siteId not found | |
NULL_ARGUMENT | installationReceiver, siteId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.SiteLookupSession | a SiteLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSiteLookup() is false | ||
Compliance | optional | This method must be implemented if supportsSiteLookup() is
true. | |
Method | getPackageLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.PackageLookupSession | a PackageLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPackageLookup() is false | ||
Compliance | optional | This method must be implemented if supportsPackageLookup()
is true. | |
Method | getPackageLookupSessionForDepot | ||
Description |
Gets the | ||
Parameters | osid.id.Id | depotId | the Id of the depot |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.PackageLookupSession | a PackageLookupSession | |
Errors | NOT_FOUND | depotId not found | |
NULL_ARGUMENT | depotId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.PackageQuerySession | a PackageQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPackageQuery() is false | ||
Compliance | optional | This method must be implemented if supportsPackageQuery() is
true. | |
Method | getPackageQuerySessionForDepot | ||
Description |
Gets the | ||
Parameters | osid.id.Id | depotId | the Id of the Depot |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.PackageQuerySession | a PackageQuerySession | |
Errors | NOT_FOUND | no Depot found by the given Id | |
NULL_ARGUMENT | depotId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.PackageSearchSession | a PackageSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPackageSearch() is false | ||
Compliance | optional | This method must be implemented if supportsPackageSearch()
is true. | |
Method | getPackageSearchSessionForDepot | ||
Description |
Gets the | ||
Parameters | osid.id.Id | depotId | the Id of the depot |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.PackageSearchSession | a PackageSearchSession | |
Errors | NOT_FOUND | depotId not found | |
NULL_ARGUMENT | depotId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.PackageAdminSession | a PackageAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPackageAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPackageAdmin() is
true. | |
Method | getPackageAdminSessionForDepot | ||
Description |
Gets the | ||
Parameters | osid.id.Id | depotId | the Id of the depot |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.PackageAdminSession | a PackageAdminSession | |
Errors | NOT_FOUND | depotId not found | |
NULL_ARGUMENT | depotId or proxy 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 |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.PackageNotificationSession | a PackageNotificationSession | |
Errors | NULL_ARGUMENT | packageReceiver or proxy 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 | ||
Parameters | osid.installation.PackageReceiver | packageReceiver | the package receiver |
osid.id.Id | depotId | the Id of the depot | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.PackageNotificationSession | a PackageNotificationSession | |
Errors | NOT_FOUND | depotId not found | |
NULL_ARGUMENT | packageReceiver, depotId or proxy 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. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.PackageDepotSession | a PackageDepotSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
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. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.PackageDepotSession | a PackageDepotAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
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 |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.PackageSmartDepotSession | a PackageSmartDepotSession | |
Errors | NOT_FOUND | depotId not found | |
NULL_ARGUMENT | depotId or proxy 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. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.DepotLookupSession | a DepotLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDepotLookup() is false | ||
Compliance | optional | This method must be implemented if supportsDepotLookup() is
true. | |
Method | getDepotQuerySession | ||
Description |
Gets the depot query session. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.DepotQuerySession | a DepotQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
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. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.DepotSearchSession | a DepotSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
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. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.DepotAdminSession | a DepotAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
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 |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.installation.DepotNotificationSession | a DepotNotificationSession | |
Errors | NULL_ARGUMENT | depotReceiver or proxy 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. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.DepotHierarchySession | a DepotHierarchySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDepotHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsDepotHierarchy()
is true. | |
Method | getDepotHierarchyDesignSession | ||
Description |
Gets the session designing depot hierarchies. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.installation.DepotHierarchyDesignSession | a DepotHierarchyDesignSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDepotHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsDepotHierarchyDesign()
is true. | |
Method | getInstallationBatchProxyManager | ||
Description |
Gets an | ||
Return | osid.installation.batch.InstallationBatchProxyManager | an InstallationBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInstallationBatch() is false | ||
Compliance | optional | This method must be implemented if supportsInstallationBatch()
is true. |