Interface OsidSourceableForm

All Superinterfaces:

Identifiable, OsidForm, Suppliable

All Known Subinterfaces:

AcademyBatchForm, AcademyForm, AddressBookBatchForm, AddressBookForm, AgencyBatchForm, AgencyForm, AgentBatchForm, AntimatroidForm, AssetBatchForm, AssetForm, AuctionBatchForm, AuctionForm, AuctionHouseBatchForm, AuctionHouseForm, AuditForm, BallotBatchForm, BallotForm, BankBatchForm, BankForm, BillingBatchForm, BillingForm, BinBatchForm, BinForm, BlogBatchForm, BlogForm, BookBatchForm, BookForm, BrokerBatchForm, BrokerForm, BudgetBatchForm, BudgetEntryBatchForm, BusinessBatchForm, BusinessBatchForm, BusinessForm, BusinessForm, CalendarBatchForm, CalendarForm, CampusBatchForm, CampusForm, CatalogForm, CatalogueBatchForm, CatalogueForm, ChecklistBatchForm, ChecklistForm, CompositionBatchForm, CompositionForm, ConfigurationBatchForm, ConfigurationForm, ConvocationBatchForm, ConvocationForm, CookbookBatchForm, CookbookForm, CourseCatalogBatchForm, CourseCatalogForm, DepotBatchForm, DepotForm, DictionaryBatchForm, DictionaryForm, DirectoryForm, DispatchBatchForm, DispatchForm, DistributorBatchForm, DistributorForm, EngineForm, EngineForm, EntryBatchForm, EntryForm, FamilyBatchForm, FamilyForm, ForumBatchForm, ForumForm, FoundryBatchForm, FoundryForm, FrontOfficeBatchForm, FrontOfficeForm, GradebookBatchForm, GradebookForm, GraphBatchForm, GraphForm, HierarchyForm, InquestBatchForm, InquestForm, IssueBatchForm, IssueForm, JobBatchForm, JobForm, JournalBatchForm, JournalForm, LogBatchForm, LogForm, MailboxBatchForm, MailboxForm, MapBatchForm, MapForm, ObjectiveBankBatchForm, ObjectiveBankForm, OfficeBatchForm, OfficeForm, OntologyBatchForm, OntologyForm, OsidCatalogForm, OsidGovernatorForm, OublietteBatchForm, OublietteForm, PackageBatchForm, PackageForm, PollsBatchForm, PollsForm, PoolBatchForm, PoolForm, PostBatchForm, PostEntryBatchForm, PressBatchForm, PressForm, ProcessBatchForm, ProcessForm, ProcessForm, ProfileBatchForm, ProfileForm, PublisherBatchForm, PublisherForm, QueueBatchForm, QueueBatchForm, QueueForm, QueueForm, RaceBatchForm, RaceForm, RealmBatchForm, RealmForm, RecipeBatchForm, RecipeForm, RepositoryBatchForm, RepositoryForm, StoreBatchForm, StoreForm, SystemBatchForm, SystemForm, UtilityBatchForm, UtilityForm, VaultBatchForm, VaultForm, WarehouseForm

public interface OsidSourceableForm
extends OsidForm

This form is used to create and update sourceables.

Method Summary

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.

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 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.

Method Details

getProviderMetadata

Metadata getProviderMetadata()

Gets the metadata for a provider.

Returns:

metadata for the provider

Compliance:

mandatory - This method must be implemented.

setProvider

void setProvider(Id providerId)

Sets a provider.

Parameters:

providerId - the new provider

Throws:

InvalidArgumentException - providerId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - providerId is null

Compliance:

mandatory - This method must be implemented.

clearProvider

void clearProvider()

Removes the provider.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getBrandingMetadata

Metadata getBrandingMetadata()

Gets the metadata for the asset branding.

Returns:

metadata for the asset branding.

Compliance:

mandatory - This method must be implemented.

setBranding

void setBranding(Id[] assetIds)

Sets the branding.

Parameters:

assetIds - the new assets

Throws:

InvalidArgumentException - assetIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - assetIds is null

Compliance:

mandatory - This method must be implemented.

clearBranding

void clearBranding()

Removes the branding.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getLicenseMetadata

Metadata getLicenseMetadata()

Gets the metadata for the license.

Returns:

metadata for the license

Compliance:

mandatory - This method must be implemented.

setLicense

void setLicense(String license)

Sets the license.

Parameters:

license - the new license

Throws:

InvalidArgumentException - license is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - license is null

Compliance:

mandatory - This method must be implemented.

clearLicense

void clearLicense()

Removes the license.

Throws:

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

Compliance:

mandatory - This method must be implemented.