Interface ParameterForm

All Superinterfaces:

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

All Known Subinterfaces:

ParameterBatchForm

public interface ParameterForm
extends OsidRuleForm

This is the form for creating and updating Parameters. Various data elements may be set here for use in the create and update methods in the ParameterAdminSession. 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	clearValueCoordinateType()	Clears the coordinate type.
void	clearValueHeadingType()	Clears the heading type.
void	clearValueObjectType()	Clears the object value type.
void	clearValueSpatialUnitRecordType()	Clears the spatial unit record type.
void	clearValuesShuffled()	Clears the shuffle flag.
void	clearValueSyntax()	Clears the value syntax.
void	clearValueVersionScheme()	Clears the version value type.
ParameterFormRecord	getParameterFormRecord(Type parameterRecordType)	Gets the ParameterFormRecord corresponding to the given parameter record Type.
Metadata	getValueCoordinateTypeMetadata()	Gets the metadata for the coordinate type for coordinate values.
Metadata	getValueHeadingTypeMetadata()	Gets the metadata for the heading type for coordinate values.
Metadata	getValueObjectTypeMetadata()	Gets the metadata for the object value type for object values.
Metadata	getValueSpatialUnitRecordTypeMetadata()	Gets the metadata for the spatial unit record type for coordinate values.
Metadata	getValuesShuffledMetadata()	Gets the metadata for the shuffle type.
Metadata	getValueSyntaxMetadata()	Gets the metadata for the value syntax.
Metadata	getValueVersionSchemeMetadata()	Gets the metadata for the version type for object values.
void	setValueCoordinateType(Type coordinateType)	Sets a coordinate type.
void	setValueHeadingType(Type headingType)	Sets a heading type.
void	setValueObjectType(Type objectType)	Sets an object value type.
void	setValueSpatialUnitRecordType(Type spatialUnitRecordType)	Sets a spatial unit record type.
void	setValuesShuffled(boolean shuffle)	Sets the shuffle order.
void	setValueSyntax(Syntax syntax)	Sets a value syntax.
void	setValueVersionScheme(Type versionType)	Sets a version type.

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

getValueSyntaxMetadata

Metadata getValueSyntaxMetadata()

Gets the metadata for the value syntax.

Returns:

metadata for the value syntax

Compliance:

mandatory - This method must be implemented.

setValueSyntax

void setValueSyntax(Syntax syntax)

Sets a value syntax.

Parameters:

syntax - the new value synatx

Throws:

InvalidArgumentException - syntax is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - syntax is null

Compliance:

mandatory - This method must be implemented.

clearValueSyntax

void clearValueSyntax()

Clears the value syntax.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getValueCoordinateTypeMetadata

Metadata getValueCoordinateTypeMetadata()

Gets the metadata for the coordinate type for coordinate values.

Returns:

metadata for the coordinate type

Compliance:

mandatory - This method must be implemented.

setValueCoordinateType

void setValueCoordinateType(Type coordinateType)

Sets a coordinate type.

Parameters:

coordinateType - the new coordinate type

Throws:

InvalidArgumentException - coordinateType is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - coordinateType is null

Compliance:

mandatory - This method must be implemented.

clearValueCoordinateType

void clearValueCoordinateType()

Clears the coordinate type.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getValueHeadingTypeMetadata

Metadata getValueHeadingTypeMetadata()

Gets the metadata for the heading type for coordinate values.

Returns:

metadata for the heading type

Compliance:

mandatory - This method must be implemented.

setValueHeadingType

void setValueHeadingType(Type headingType)

Sets a heading type.

Parameters:

headingType - the new heading type

Throws:

InvalidArgumentException - headingType is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - headingType is null

Compliance:

mandatory - This method must be implemented.

clearValueHeadingType

void clearValueHeadingType()

Clears the heading type.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getValueObjectTypeMetadata

Metadata getValueObjectTypeMetadata()

Gets the metadata for the object value type for object values.

Returns:

metadata for the object type

Compliance:

mandatory - This method must be implemented.

setValueObjectType

void setValueObjectType(Type objectType)

Sets an object value type.

Parameters:

objectType - the new object type

Throws:

InvalidArgumentException - objectType is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - objectType is null

Compliance:

mandatory - This method must be implemented.

clearValueObjectType

void clearValueObjectType()

Clears the object value type.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getValueSpatialUnitRecordTypeMetadata

Metadata getValueSpatialUnitRecordTypeMetadata()

Gets the metadata for the spatial unit record type for coordinate values.

Returns:

metadata for the spatial unit record type

Compliance:

mandatory - This method must be implemented.

setValueSpatialUnitRecordType

void setValueSpatialUnitRecordType(Type spatialUnitRecordType)

Sets a spatial unit record type.

Parameters:

spatialUnitRecordType - the new spatial unit record type

Throws:

InvalidArgumentException - spatialUnitRecordType is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - spatialUnitRecordType is null

Compliance:

mandatory - This method must be implemented.

clearValueSpatialUnitRecordType

void clearValueSpatialUnitRecordType()

Clears the spatial unit record type.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getValueVersionSchemeMetadata

Metadata getValueVersionSchemeMetadata()

Gets the metadata for the version type for object values.

Returns:

metadata for the version type

Compliance:

mandatory - This method must be implemented.

setValueVersionScheme

void setValueVersionScheme(Type versionType)

Sets a version type.

Parameters:

versionType - the new version type

Throws:

InvalidArgumentException - versionType is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - versionType is null

Compliance:

mandatory - This method must be implemented.

clearValueVersionScheme

void clearValueVersionScheme()

Clears the version value type.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getValuesShuffledMetadata

Metadata getValuesShuffledMetadata()

Gets the metadata for the shuffle type.

Returns:

metadata for the shuffle flag

Compliance:

mandatory - This method must be implemented.

setValuesShuffled

void setValuesShuffled(boolean shuffle)

Sets the shuffle order.

Parameters:

shuffle - true to shuffle values by weight, false to order values by index

Throws:

InvalidArgumentException - shuffle is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearValuesShuffled

void clearValuesShuffled()

Clears the shuffle flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getParameterFormRecord

ParameterFormRecord getParameterFormRecord(Type parameterRecordType)
                                    throws OperationFailedException

Gets the ParameterFormRecord corresponding to the given parameter record Type.

Parameters:

parameterRecordType - a parameter record type

Returns:

the parameter form record

Throws:

NullArgumentException - parameterRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterRecordType) is false

Compliance:

mandatory - This method must be implemented.