public interface Package extends OsidObject, Sourceable
A Package
represents an installation bundle in a depot.
Modifier and Type | Method and Description |
---|---|
DisplayText |
getCopyright()
Gets the copyright of this package.
|
Resource |
getCreator()
Gets the creator
Id of this package. |
Id |
getCreatorId()
Gets the creator or author of this package.
|
PackageList |
getDependencies()
Gets the packages on which this package directly depends.
|
IdList |
getDependencyIds()
Gets the package
Ids on which this package directly
depends. |
IdList |
getInstallationContentIds()
Gets the installation content
Ids. |
InstallationContentList |
getInstallationContents()
Gets the installation contents.
|
PackageRecord |
getPackageRecord(Type packageRecordType)
Gets the package record corresponding to the given
Package
record Type. |
DateTime |
getReleaseDate()
Gets the release date of this package.
|
java.lang.String |
getURL()
Gets a url for this package.
|
Version |
getVersion()
Gets the version of this package.
|
boolean |
requestsLicenseAcknowledgement()
Tests if the provider requests acknowledgement of the license.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
Version getVersion()
mandatory
- This method must be implemented. DisplayText getCopyright()
mandatory
- This method must be implemented. boolean requestsLicenseAcknowledgement()
true
if the consumer should acknowledge the
terms in the license, false
otherwisemandatory
- This method must be implemented. Id getCreatorId()
Id
mandatory
- This method must be implemented. Resource getCreator() throws OperationFailedException
Id
of this package.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getReleaseDate()
mandatory
- This method must be implemented. IdList getDependencyIds()
Ids
on which this package directly
depends. Ids
mandatory
- This method must be implemented. PackageList getDependencies() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. java.lang.String getURL()
mandatory
- This method must be implemented. IdList getInstallationContentIds() throws OperationFailedException
Ids.
Ids
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. InstallationContentList getInstallationContents() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. PackageRecord getPackageRecord(Type packageRecordType) throws OperationFailedException
Package
record Type.
This method is used to retrieve an
object implementing the requested record. The packageRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(packageRecordType)
is true
.packageRecordType
- the type of the record to retrieveNullArgumentException
- packageRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(packageRecordType)
is false
mandatory
- This method must be implemented.