OSID - osid.installation.InstallationPackage Service Interface Definition

Interface	osid.installation.InstallationPackage
Implements	`osid.OsidObject`
Implements	`osid.Sourceable`
Used By	`osid.installation.Installation`
	`osid.installation.InstallationContent`
	`osid.installation.InstallationPackageAdminSession`
	`osid.installation.InstallationPackageList`
	`osid.installation.InstallationPackageLookupSession`
Description	A `InstallationPackage` represents an installation bundle in a depot.
Method	getVersion
Description	Gets the version of this package.
Return	`osid.installation.Version`		the package version
Compliance	`mandatory`		This method must be implemented.
Method	getCopyright
Description	Gets the copyright of this package.
Return	`osid.locale.DisplayText`		the copyright
Compliance	`mandatory`		This method must be implemented.
Method	requestsLicenseAcknowledgement
Description	Tests if the provider requests acknowledgement of the license.
Return	`boolean`		`true` if the consumer should acknowledge the terms in the license, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCreatorId
Description	Gets the creator or author of this package.
Return	`osid.id.Id`		the creator `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCreator
Description	Gets the creator `Id` of this package.
Return	`osid.resource.Resource`		the creator
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getReleaseDate
Description	Gets the release date of this package.
Return	`osid.calendaring.DateTime`		the timestamp of this package
Compliance	`mandatory`		This method must be implemented.
Method	getDependencyIds
Description	Gets the package `Ids` on which this package directly depends.
Return	`osid.id.IdList`		the package dependency `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getDependencies
Description	Gets the packages on which this package directly depends.
Return	`osid.installation.InstallationPackageList`		the package dependencies
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getURL
Description	Gets a url for this package. The url may point to an external project or product site. If no url is available an empty string is returned.
Return	`string`		the url for this package
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationContentIds
Description	Gets the installation content `Ids`.
Return	`osid.id.IdList`		the installation content `Ids`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationContents
Description	Gets the installation contents.
Return	`osid.installation.InstallationContentList`		the installation contents
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getInstallationPackageRecord
Description	Gets the package record corresponding to the given `InstallationPackage` record `Type` .This method is used to retrieve an object implementing the requested record. The `installationPackageRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(packageRecordType)` is `true`.
Parameters	`osid.type.Type`	`installationPackageRecordType`	the type of the record to retrieve
Return	`osid.installation.records.InstallationPackageRecord`		the package record
Errors	NULL_ARGUMENT		`installationPackageRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(packageRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.