Interface PackageForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

PackageBatchForm

public interface PackageForm
extends OsidObjectForm, OsidSourceableForm

This is the form for creating and updating Packages . Like all OsidForms . various data elements may be set here for use in the create and update methods in the PackageAdminSession . For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Modifier and Type	Method	Description
void	clearCopyright()	Clears the version.
void	clearCreator()	Clears the creator.
void	clearDependencies()	Clears the package dependencies.
void	clearReleaseDate()	Clears the release date.
void	clearRequiresLicenseAcknowledgement()	Clears the acknowledgement flag.
void	clearURL()	Clears the url.
void	clearVersion()	Clears the version.
Metadata	getCopyrightMetadata()	Gets the metadata for a copyright.
Metadata	getCreatorMetadata()	Gets the metadata for a creator resource.
Metadata	getDependenciesMetadata()	Gets the metadata for the package dependencies.
PackageFormRecord	getPackageFormRecord(Type packageRecordType)	Gets the PackageFormRecord corresponding to the given package record Type .
Metadata	getReleaseDateMetadata()	Gets the metadata for the release date.
Metadata	getRequiresLicenseAcknowledgementMetadata()	Gets the metadata for the requires license acknowledgement flag.
Metadata	getURLMetadata()	Gets the metadata for the url.
Metadata	getVersionMetadata()	Gets the metadata for a version.
void	setCopyright(String copyright)	Sets the copyright.
void	setCreator(Id resourceId)	Sets the creator resource.
void	setDependencies(Id[] packageIds)	Sets the dependencies.
void	setReleaseDate(DateTime releaseDate)	Sets the publisher release date.
void	setRequiresLicenseAcknowledgement(boolean requiresLicenseAcknowledgement)	Sets the requires license acknowledgement flag.
void	setURL(String url)	Sets the url.
void	setVersion(Version version)	Sets the version.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Modifier and Type	Method	Description
void	clearBranding()	Removes the branding.
void	clearLicense()	Removes the license.
void	clearProvider()	Removes the provider.
Metadata	getBrandingMetadata()	Gets the metadata for the asset branding.
Metadata	getLicenseMetadata()	Gets the metadata for the license.
Metadata	getProviderMetadata()	Gets the metadata for a provider.
void	setBranding(Id[] assetIds)	Sets the branding.
void	setLicense(String license)	Sets the license.
void	setProvider(Id providerId)	Sets a provider.

Method Details

getVersionMetadata

Metadata getVersionMetadata()

Gets the metadata for a version.

Returns:

metadata for the version

Compliance:

mandatory - This method must be implemented.

setVersion

void setVersion(Version version)

Sets the version.

Parameters:

version - the new version

Throws:

InvalidArgumentException - version is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - version is null

Compliance:

mandatory - This method must be implemented.

clearVersion

void clearVersion()

Clears the version.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCopyrightMetadata

Metadata getCopyrightMetadata()

Gets the metadata for a copyright.

Returns:

metadata for the copyright

Compliance:

mandatory - This method must be implemented.

setCopyright

void setCopyright(String copyright)

Sets the copyright.

Parameters:

copyright - the new copyright

Throws:

InvalidArgumentException - copyright is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - copyright is null

Compliance:

mandatory - This method must be implemented.

clearCopyright

void clearCopyright()

Clears the version.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRequiresLicenseAcknowledgementMetadata

Metadata getRequiresLicenseAcknowledgementMetadata()

Gets the metadata for the requires license acknowledgement flag.

Returns:

metadata for the acknowledgement flag

Compliance:

mandatory - This method must be implemented.

setRequiresLicenseAcknowledgement

void setRequiresLicenseAcknowledgement(boolean requiresLicenseAcknowledgement)

Sets the requires license acknowledgement flag.

Parameters:

requiresLicenseAcknowledgement - the new ackknowledgement flag

Throws:

InvalidArgumentException - requiresLicenseAcknowledgement is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearRequiresLicenseAcknowledgement

void clearRequiresLicenseAcknowledgement()

Clears the acknowledgement flag.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCreatorMetadata

Metadata getCreatorMetadata()

Gets the metadata for a creator resource.

Returns:

metadata for the creator resource

Compliance:

mandatory - This method must be implemented.

setCreator

void setCreator(Id resourceId)

Sets the creator resource.

Parameters:

resourceId - the new creator resource

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearCreator

void clearCreator()

Clears the creator.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getReleaseDateMetadata

Metadata getReleaseDateMetadata()

Gets the metadata for the release date.

Returns:

metadata for the release date

Compliance:

mandatory - This method must be implemented.

setReleaseDate

void setReleaseDate(DateTime releaseDate)

Sets the publisher release date.

Parameters:

releaseDate - the new release date

Throws:

InvalidArgumentException - releaseDate is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - releaseDate is null

Compliance:

mandatory - This method must be implemented.

clearReleaseDate

void clearReleaseDate()

Clears the release date.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getDependenciesMetadata

Metadata getDependenciesMetadata()

Gets the metadata for the package dependencies.

Returns:

metadata for the package dependencies

Compliance:

mandatory - This method must be implemented.

setDependencies

void setDependencies(Id[] packageIds)

Sets the dependencies.

Parameters:

packageIds - the new package dependencies

Throws:

InvalidArgumentException - packageIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - packageIds is null

Compliance:

mandatory - This method must be implemented.

clearDependencies

void clearDependencies()

Clears the package dependencies.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getURLMetadata

Metadata getURLMetadata()

Gets the metadata for the url.

Returns:

metadata for the url

Compliance:

mandatory - This method must be implemented.

setURL

void setURL(String url)

Sets the url.

Parameters:

url - the new url

Throws:

InvalidArgumentException - url is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - url is null

Compliance:

mandatory - This method must be implemented.

clearURL

void clearURL()

Clears the url.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getPackageFormRecord

PackageFormRecord getPackageFormRecord(Type packageRecordType)
                                throws OperationFailedException

Gets the PackageFormRecord corresponding to the given package record Type .

Parameters:

packageRecordType - the package record type

Returns:

the package form record

Throws:

NullArgumentException - packageRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(packageRecordType) is false

Compliance:

mandatory - This method must be implemented.