Interface Parameter

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, Subjugateable

public interface Parameter
extends OsidObject, Subjugateable

A Parameter specifies a variable substitution in the string of a Text to produce an Idiom .

Method Summary

Modifier and Type	Method	Description
long	getInputPosition()	Gets the input position for this parameter as supplied to the text.
ParameterRecord	getParameterRecord(Type parameterRecordType)	Gets the parameter record corresponding to the given Parameter record Type .
Syntax	getSyntax()	Gets the syntax of the parameter.
Text	getText()	Gets the text.
Id	getTextId()	Gets the text Id .

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record 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 OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Method Details

getTextId

Id getTextId()

Gets the text Id .

Returns:

the text Id

Compliance:

mandatory - This method must be implemented.

getText

Text getText()
      throws OperationFailedException

Gets the text.

Returns:

the text

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getSyntax

Syntax getSyntax()

Gets the syntax of the parameter.

Returns:

the syntax

Compliance:

mandatory - This method must be implemented.

getInputPosition

long getInputPosition()

Gets the input position for this parameter as supplied to the text.

Returns:

the position

Compliance:

mandatory - This method must be implemented.

getParameterRecord

ParameterRecord getParameterRecord(Type parameterRecordType)
                            throws OperationFailedException

Gets the parameter record corresponding to the given Parameter record Type . This method is used to retrieve an object implementing the requested record. The parameterRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(parameterRecordType) is true .

Parameters:

parameterRecordType - the type of parameter record to retrieve

Returns:

the parameter record

Throws:

NullArgumentException - parameterRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterRecordType) is false

Compliance:

mandatory - This method must be implemented.