OSID - osid.repository.AssetForm Service Interface Definition

Interface	osid.repository.AssetForm
Implements	`osid.OsidObjectForm`
	`osid.OsidAggregateableForm`
	`osid.OsidSourceableForm`
Implemented By	`osid.repository.batch.AssetBatchForm`
Used By	`osid.repository.AssetAdminSession`
Description	This is the form for creating and updating `Assets`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `AssetAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getTitleMetadata
Description	Gets the metadata for an asset title.
Return	`osid.Metadata`		metadata for the title
Compliance	`mandatory`		This method must be implemented.
Method	setTitle
Description	Sets the title.
Parameters	`string`	`title`	the new title
Errors	INVALID_ARGUMENT		`title` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`title` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTitle
Description	Removes the title.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPublicDomainMetadata
Description	Gets the metadata for the public domain flag.
Return	`osid.Metadata`		metadata for the public domain
Compliance	`mandatory`		This method must be implemented.
Method	setPublicDomain
Description	Sets the public domain flag.
Parameters	`boolean`	`publicDomain`	the public domain status
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearPublicDomain
Description	Removes the public domain status.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCopyrightMetadata
Description	Gets the metadata for the copyright.
Return	`osid.Metadata`		metadata for the copyright
Compliance	`mandatory`		This method must be implemented.
Method	setCopyright
Description	Sets the copyright.
Parameters	`string`	`copyright`	the new copyright
Errors	INVALID_ARGUMENT		`copyright` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`copyright` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCopyright
Description	Removes the copyright.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCopyrightRegistrationMetadata
Description	Gets the metadata for the copyright registration.
Return	`osid.Metadata`		metadata for the copyright registration
Compliance	`mandatory`		This method must be implemented.
Method	setCopyrightRegistration
Description	Sets the copyright registration.
Parameters	`string`	`registration`	the new copyright registration
Errors	INVALID_ARGUMENT		`copyright` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`copyright` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCopyrightRegistration
Description	Removes the copyright registration.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDistributeVerbatimMetadata
Description	Gets the metadata for the distribute verbatim rights flag.
Return	`osid.Metadata`		metadata for the distribution rights fields
Compliance	`mandatory`		This method must be implemented.
Method	setDistributeVerbatim
Description	Sets the distribution rights.
Parameters	`boolean`	`distributeVerbatim`	right to distribute verbatim copies
Errors	INVALID_ARGUMENT		`distributeVerbatim` is invalid
Errors	NO_ACCESS		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	clearDistributeVerbatim
Description	Removes the distribution rights.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDistributeAlterationsMetadata
Description	Gets the metadata for the distribute alterations rights flag.
Return	`osid.Metadata`		metadata for the distribution rights fields
Compliance	`mandatory`		This method must be implemented.
Method	setDistributeAlterations
Description	Sets the distribute alterations flag. This also sets distribute verbatim to `true`.
Parameters	`boolean`	`distributeMods`	right to distribute modifications
Errors	INVALID_ARGUMENT		`distributeMods` is invalid
Errors	NO_ACCESS		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	clearDistributeAlterations
Description	Removes the distribution rights.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDistributeCompositionsMetadata
Description	Gets the metadata for the distribute compositions rights flag.
Return	`osid.Metadata`		metadata for the distribution rights fields
Compliance	`mandatory`		This method must be implemented.
Method	setDistributeCompositions
Description	Sets the distribution rights. This sets distribute verbatim to `true`.
Parameters	`boolean`	`distributeComps`	right to distribute modifications
Errors	INVALID_ARGUMENT		`distributeComps` is invalid
Errors	NO_ACCESS		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	clearDistributeCompositions
Description	Removes the distribution rights.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSourceMetadata
Description	Gets the metadata for the source.
Return	`osid.Metadata`		metadata for the source
Compliance	`mandatory`		This method must be implemented.
Method	setSource
Description	Sets the source.
Parameters	`osid.id.Id`	`sourceId`	the new publisher
Errors	INVALID_ARGUMENT		`sourceId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`sourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSource
Description	Removes the source.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProviderLinksMetadata
Description	Gets the metadata for the provider chain.
Return	`osid.Metadata`		metadata for the provider chain
Compliance	`mandatory`		This method must be implemented.
Method	setProviderLinks
Description	Sets a provider chain in order from the most recent source to the originating source.
Parameters	`osid.id.Id[]`	`resourceIds`	the new source
Errors	INVALID_ARGUMENT		`resourceIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`resourceIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProviderLinks
Description	Removes the provider chain.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCreatedDateMetadata
Description	Gets the metadata for the asset creation date.
Return	`osid.Metadata`		metadata for the created date
Compliance	`mandatory`		This method must be implemented.
Method	setCreatedDate
Description	Sets the created date.
Parameters	`osid.calendaring.DateTime`	`createdDate`	the new created date
Errors	INVALID_ARGUMENT		`createdDate` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`createdDate` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCreatedDate
Description	Removes the created date.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPublishedMetadata
Description	Gets the metadata for the published status.
Return	`osid.Metadata`		metadata for the published field
Compliance	`mandatory`		This method must be implemented.
Method	setPublished
Description	Sets the published status.
Parameters	`boolean`	`published`	the published status
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearPublished
Description	Removes the published status.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPublishedDateMetadata
Description	Gets the metadata for the published date.
Return	`osid.Metadata`		metadata for the published date
Compliance	`mandatory`		This method must be implemented.
Method	setPublishedDate
Description	Sets the published date.
Parameters	`osid.calendaring.DateTime`	`publishedDate`	the new published date
Errors	INVALID_ARGUMENT		`publishedDate` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`publishedDate` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPublishedDate
Description	Removes the puiblished date.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPrincipalCreditStringMetadata
Description	Gets the metadata for the principal credit display text.
Return	`osid.Metadata`		metadata for the credits
Compliance	`mandatory`		This method must be implemented.
Method	setPrincipalCreditString
Description	Sets the principal credits display text.
Parameters	`string`	`credits`	the new credits
Errors	INVALID_ARGUMENT		`credits` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`credits` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPrincipalCreditString
Description	Removes the principal credit text.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionMetadata
Description	Gets the metadata for linking this asset to a composition.
Return	`osid.Metadata`		metadata for the composition
Compliance	`mandatory`		This method must be implemented.
Method	setComposition
Description	Sets the composition.
Parameters	`osid.id.Id`	`compositionId`	a composition
Errors	INVALID_ARGUMENT		`compositionId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`compositionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearComposition
Description	Removes the composition link.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAssetFormRecord
Description	Gets the `AssetFormRecord` corresponding to the given `Asset` record `Type`.
Parameters	`osid.type.Type`	`assetRecordType`	an asset record type
Return	`osid.repository.records.AssetFormRecord`		the asset form record
Errors	NULL_ARGUMENT		`assetRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(assetRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.