Interface FunctionForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable

All Known Subinterfaces:

FunctionBatchForm

public interface FunctionForm
extends OsidRuleForm

This is the form for creating and updating Functions. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the FunctionAdminSession. 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	clearQualifierHierarchy()	Clears the qualifier hierarchy.
FunctionFormRecord	getFunctionFormRecord(Type functionRecordType)	Gets the FunctionFormRecord corresponding to the given function record Type.
Metadata	getQualifierHierarchyMetadata()	Gets the metadata for a qualifier hierarchy.
void	setQualifierHierarchy(Id qualifierHierarchyId)	Sets the qualifier hierarchy.

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 OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Method Details

getQualifierHierarchyMetadata

Metadata getQualifierHierarchyMetadata()

Gets the metadata for a qualifier hierarchy.

Returns:

metadata for the qualifier hierarchy

Compliance:

mandatory - This method must be implemented.

setQualifierHierarchy

void setQualifierHierarchy(Id qualifierHierarchyId)

Sets the qualifier hierarchy.

Parameters:

qualifierHierarchyId - the new qualifier hierarchy

Throws:

InvalidArgumentException - qualifierHierarchyId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - qualifierHierarchyId is null

Compliance:

mandatory - This method must be implemented.

clearQualifierHierarchy

void clearQualifierHierarchy()

Clears the qualifier hierarchy.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getFunctionFormRecord

FunctionFormRecord getFunctionFormRecord(Type functionRecordType)
                                  throws OperationFailedException

Gets the FunctionFormRecord corresponding to the given function record Type.

Parameters:

functionRecordType - the function record type

Returns:

the function form record

Throws:

NullArgumentException - functionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(functionRecordType) is false

Compliance:

mandatory - This method must be implemented.