public interface PackageForm extends OsidObjectForm, OsidSourceableForm
This is the form for creating and updating Packages.
Like all OsidForm
objects, 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.
Modifier and Type | Method and 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(java.lang.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(java.lang.String url)
Sets the url.
|
void |
setVersion(Version version)
Sets the version.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider
Metadata getVersionMetadata()
mandatory
- This method must be implemented. void setVersion(Version version)
version
- the new versionInvalidArgumentException
- version
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- version
is
null
mandatory
- This method must be implemented. void clearVersion()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCopyrightMetadata()
mandatory
- This method must be implemented. void setCopyright(java.lang.String copyright)
copyright
- the new copyrightInvalidArgumentException
- copyright
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- copyright
is
null
mandatory
- This method must be implemented. void clearCopyright()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRequiresLicenseAcknowledgementMetadata()
mandatory
- This method must be implemented. void setRequiresLicenseAcknowledgement(boolean requiresLicenseAcknowledgement)
requiresLicenseAcknowledgement
- the new ackknowledgement flagInvalidArgumentException
-
requiresLicenseAcknowledgement
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearRequiresLicenseAcknowledgement()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCreatorMetadata()
mandatory
- This method must be implemented. void setCreator(Id resourceId)
resourceId
- the new creator resourceInvalidArgumentException
- resourceId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearCreator()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getReleaseDateMetadata()
mandatory
- This method must be implemented. void setReleaseDate(DateTime releaseDate)
releaseDate
- the new release dateInvalidArgumentException
- releaseDate
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- releaseDate
is
null
mandatory
- This method must be implemented. void clearReleaseDate()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDependenciesMetadata()
mandatory
- This method must be implemented. void setDependencies(Id[] packageIds)
packageIds
- the new package dependenciesInvalidArgumentException
- packageIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- packageIds
is
null
mandatory
- This method must be implemented. void clearDependencies()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getURLMetadata()
mandatory
- This method must be implemented. void setURL(java.lang.String url)
url
- the new urlInvalidArgumentException
- url
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- url
is
null
mandatory
- This method must be implemented. void clearURL()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. PackageFormRecord getPackageFormRecord(Type packageRecordType) throws OperationFailedException
PackageFormRecord
corresponding to the given
package record Type.
packageRecordType
- the package record typeNullArgumentException
- packageRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(packageRecordType)
is false
mandatory
- This method must be implemented.