OSID - osid.installation.InstallationProfile Service Interface Definition

Interface	osid.installation.InstallationProfile
Implements	`osid.OsidProfile`
Description	The `InstallationProfile` describes the interoperability among installation services.
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	supportsPackageLookup
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	supportsPackageQuery
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	supportsPackageSearch
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	supportsPackageAdmin
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	supportsPackageNotification
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	supportsPackageDepot
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	supportsPackageDepotAssignment
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	supportsPackageSmartDepot
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 `Installation` record types.
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 `Installation` record type is supported.
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 `Installation` search record types.
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 `Installation` search record type is supported.
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 `Site` record types.
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 `Site` record type is supported.
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	getPackageRecordTypes
Description	Gets the supported `Package` record types.
Return	`osid.type.TypeList`		a list containing the supported `Package` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPackageRecordType
Description	Tests if the given `Package` record type is supported.
Parameters	`osid.type.Type`	`packageRecordType`	a `Type` indicating a `Package` record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`packageRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPackageSearchRecordTypes
Description	Gets the supported `Package` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Package` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPackageSearchRecordType
Description	Tests if the given `Package` search record type is supported.
Parameters	`osid.type.Type`	`packageSearchRecordType`	a `Type` indicating a `Package` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`packageSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationContentRecordTypes
Description	Gets the supported `InstallationContent` record types.
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 `InstallationContent` record type is supported.
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 `Depot` record types.
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 `Depot` record type is supported.
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.