OSID Specifications
installation package
Version 3.1.0
installation package
Version 3.1.0
| Interface | osid.installation.InstallationProfile | ||
|---|---|---|---|
| Implements | osid.OsidProfile | ||
| Implemented By | osid.installation.InstallationManager | ||
osid.installation.InstallationProxyManager | |||
| Description |
The | ||
| Method | supportsVisibleFederation | ||
| Description |
Tests if federation is visible. | ||
| Return | boolean | true if visible federation is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationLookup | ||
| Description |
Tests if an installation lookup service is supported. | ||
| Return | boolean | true if installation lookup is supported, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationQuery | ||
| Description |
Tests if an installation query service is supported. | ||
| Return | boolean | true if installation query is supported, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationSearch | ||
| Description |
Tests if an installation search service is supported. | ||
| Return | boolean | true if installation search is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationManagement | ||
| Description |
Tests if an installation management service is supported. | ||
| Return | boolean | true if package management is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationUpdate | ||
| Description |
Tests if an installation update service is supported. | ||
| Return | boolean | true if package update is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationNotification | ||
| Description |
Tests if installation notification is supported. Messages may be sent when installations are installed or removed. | ||
| Return | boolean | true if installation notification is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSiteLookup | ||
| Description |
Tests if a site lookup service is supported. | ||
| Return | boolean | true if site lookup is supported, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationPackageLookup | ||
| Description |
Tests if a package lookup service is supported. A package lookup service defines methods to access packages. | ||
| Return | boolean | true if package lookup is supported, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationPackageQuery | ||
| Description |
Tests if querying packages is supported. | ||
| Return | boolean | true if packages query is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationPackageSearch | ||
| Description |
Tests if a package search service is supported. | ||
| Return | boolean | true if package search is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationPackageAdmin | ||
| Description |
Tests if a package administrative service is supported. | ||
| Return | boolean | true if package admin is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationPackageNotification | ||
| Description |
Tests if package notification is supported. Messages may be sent when packages are created, modified, or deleted. | ||
| Return | boolean | true if package notification is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationPackageDepot | ||
| Description |
Tests if a package to depot lookup session is available. | ||
| Return | boolean | true if package depot lookup session is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationPackageDepotAssignment | ||
| Description |
Tests if a package to depot assignment session is available. | ||
| Return | boolean | true if package depot assignment is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationPackageSmartDepot | ||
| Description |
Tests if package smart depots are available. | ||
| Return | boolean | true if package smart depots are supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDepotLookup | ||
| Description |
Tests if a depot lookup service is supported. | ||
| Return | boolean | true if depot lookup is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDepotQuery | ||
| Description |
Tests if a depot query service is supported. | ||
| Return | boolean | true if depot query is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDepotSearch | ||
| Description |
Tests if a depot search service is supported. | ||
| Return | boolean | true if depot search is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDepotAdmin | ||
| Description |
Tests if a depot administrative service is supported. | ||
| Return | boolean | true if depot admin is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDepotNotification | ||
| Description |
Tests if depot notification is supported. Messages may be sent when depots are created, modified, or deleted. | ||
| Return | boolean | true if depot notification is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDepotHierarchy | ||
| Description |
Tests if a depot hierarchy traversal is supported. | ||
| Return | boolean | true if a depot hierarchy traversal is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDepotHierarchyDesign | ||
| Description |
Tests if depot hierarchy design is supported. | ||
| Return | boolean | true if a depot hierarchy design is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationBatch | ||
| Description |
Tests if an installation batch service is supported. | ||
| Return | boolean | true if an installation batch service is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstallationRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported Installation record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | installationRecordType | a Type indicating an Installation record type |
| Return | boolean | true if the given Type is supported, false
otherwise | |
| Errors | NULL_ARGUMENT | installationRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstallationSearchRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported Installation search record
types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationSearchRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | installationSearchRecordType | a Type indicating an Installation search record
type |
| Return | boolean | true if the given Type is supported, false
otherwise | |
| Errors | NULL_ARGUMENT | installationSearchRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSiteRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported Site record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSiteRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | siteRecordType | a Type indicating a Site record type |
| Return | boolean | true if the given Type is supported, false
otherwise | |
| Errors | NULL_ARGUMENT | siteRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstallationPackageRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported InstallationPackage record
types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationPackageRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | installationPackageRecordType | a Type indicating a InstallationPackage record
type |
| Return | boolean | true if the given Type is supported, false
otherwise | |
| Errors | NULL_ARGUMENT | installationPackageRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstallationPackageSearchRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported InstallationPackage search
record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationPackageSearchRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | installationPackageSearchRecordType | a Type indicating a InstallationPackage search
record type |
| Return | boolean | true if the given Type is supported, false
otherwise | |
| Errors | NULL_ARGUMENT | installationPackageSearchRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstallationContentRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported InstallationContent record
types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsInstallationContentRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | installationContentRecordType | a Type indicating an InstallationContent record
type |
| Return | boolean | true if the given Type is supported, false
otherwise | |
| Errors | NULL_ARGUMENT | installationContentRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDepotRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported Depot record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDepotRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | depotRecordType | a Type indicating a Depot type |
| Return | boolean | true if the given depot record Type is
supported, false otherwise | |
| Errors | NULL_ARGUMENT | depotRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDepotSearchRecordTypes | ||
| Description |
Gets the supported depot search record types. | ||
| Return | osid.type.TypeList | a list containing the supported Depot search record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDepotSearchRecordType | ||
| Description |
Tests if the given depot search record type is supported. | ||
| Parameters | osid.type.Type | depotSearchRecordType | a Type indicating a Depot search record type |
| Return | boolean | true if the given search record Type is
supported, false otherwise | |
| Errors | NULL_ARGUMENT | depotSearchRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |