Interface OrganizationForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

OrganizationBatchForm

public interface OrganizationForm
extends OsidObjectForm, OsidFederateableForm, OsidTemporalForm

This is the form for creating and updating Organization objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the OrganizationAdminSession . 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	clearDisplayLabel()	Clears the display label.
Metadata	getDisplayLabelMetadata()	Gets the metadata for a display label.
OrganizationFormRecord	getOrganizationFormRecord(Type organizationRecordType)	Gets the OrganizationFormRecord interface corresponding to the given organization record Type .
void	setDisplayLabel(String label)	Sets the display label.

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 OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

getDisplayLabelMetadata

Metadata getDisplayLabelMetadata()

Gets the metadata for a display label.

Returns:

metadata for the label

Compliance:

mandatory - This method must be implemented.

setDisplayLabel

void setDisplayLabel(String label)

Sets the display label.

Parameters:

label - the label

Throws:

InvalidArgumentException - label is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - label is null

Compliance:

mandatory - This method must be implemented.

clearDisplayLabel

void clearDisplayLabel()

Clears the display label.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getOrganizationFormRecord

OrganizationFormRecord getOrganizationFormRecord(Type organizationRecordType)
                                          throws OperationFailedException

Gets the OrganizationFormRecord interface corresponding to the given organization record Type .

Parameters:

organizationRecordType - the organization record type

Returns:

the record

Throws:

NullArgumentException - organizationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(organizationRecordType) is false

Compliance:

mandatory - This method must be implemented.