Interface TypeForm

All Superinterfaces:

Identifiable, OsidForm, Suppliable

public interface TypeForm
extends OsidForm

This form provides a means of updating various fields in the Type . Note that the domain, authority and identifier are part of the Type identification, and as such not modifiable.

Method Summary

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayLabel()	Clears the display label.
void	clearDisplayName()	Clears the display name.
void	clearDomain()	Clears the domain.
Metadata	getDescriptionMetadata()	Gets the metadata for the description.
Metadata	getDisplayLabelMetadata()	Gets the metadata for the display label.
Metadata	getDisplayNameMetadata()	Gets the metadata for the display name.
Metadata	getDomainMetadata()	Gets the metadata for the domain.
void	setDescription(String description)	Sets a description.
void	setDisplayLabel(String displayLabel)	Seta a display label.
void	setDisplayName(String displayName)	Sets a display name.
void	setDomain(String domain)	Sets a domain.

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

getDisplayNameMetadata

Metadata getDisplayNameMetadata()

Gets the metadata for the display name.

Returns:

metadata for the display name

Compliance:

mandatory - This method must be implemented.

setDisplayName

void setDisplayName(String displayName)

Sets a display name.

Parameters:

displayName - the new display name

Throws:

InvalidArgumentException - displayName is invalid

NoAccessException - displayName cannot be modified

NullArgumentException - displayName is null

Compliance:

mandatory - This method must be implemented.

clearDisplayName

void clearDisplayName()

Clears the display name.

Throws:

NoAccessException - displayName cannot be modified

Compliance:

mandatory - This method must be implemented.

getDisplayLabelMetadata

Metadata getDisplayLabelMetadata()

Gets the metadata for the display label.

Returns:

metadata for the display label

Compliance:

mandatory - This method must be implemented.

setDisplayLabel

void setDisplayLabel(String displayLabel)

Seta a display label.

Parameters:

displayLabel - the new display label

Throws:

InvalidArgumentException - displayLabel is invalid

NoAccessException - displayLabel cannot be modified

NullArgumentException - displayLabel is null

Compliance:

mandatory - This method must be implemented.

clearDisplayLabel

void clearDisplayLabel()

Clears the display label.

Throws:

NoAccessException - displayLabel cannot be modified

Compliance:

mandatory - This method must be implemented.

getDescriptionMetadata

Metadata getDescriptionMetadata()

Gets the metadata for the description.

Returns:

metadata for the description

Compliance:

mandatory - This method must be implemented.

setDescription

void setDescription(String description)

Sets a description.

Parameters:

description - the new description

Throws:

InvalidArgumentException - description is invalid

NoAccessException - description cannot be modified

NullArgumentException - description is null

Compliance:

mandatory - This method must be implemented.

clearDescription

void clearDescription()

Clears the description.

Throws:

NoAccessException - description cannot be modified

Compliance:

mandatory - This method must be implemented.

getDomainMetadata

Metadata getDomainMetadata()

Gets the metadata for the domain.

Returns:

metadata for the domain

Compliance:

mandatory - This method must be implemented.

setDomain

void setDomain(String domain)

Sets a domain.

Parameters:

domain - the new domain

Throws:

InvalidArgumentException - domain is invalid

NoAccessException - domain cannot be modified

NullArgumentException - domain is null

Compliance:

mandatory - This method must be implemented.

clearDomain

void clearDomain()

Clears the domain.

Throws:

NoAccessException - domain cannot be modified

Compliance:

mandatory - This method must be implemented.