com.wiris.quizzes.api.assertion

Interface Syntax

All Superinterfaces:

Serializable

public interface Syntax
extends Serializable

This object represents the expected syntax for the author answers and the student's answer in a given Slot.

Since:

4.0.0

See Also:

SyntaxName, SyntaxParameterName

Method Summary

Modifier and Type	Method and Description
SyntaxName	getName() Returns the name of this syntax assertion.
java.lang.String	getParameter(SyntaxParameterName name) Gets the value of a parameter in this syntax assertion.
java.lang.String	removeParameter(SyntaxParameterName name) Removes a parameter from this syntax assertion, setting its value back to the default value.
void	setParameter(SyntaxParameterName name, java.lang.String value) Sets a parameter's value for this syntax assertion.

Methods inherited from interface com.wiris.quizzes.api.Serializable

serialize

Method Detail

getName

SyntaxName getName()

Returns the name of this syntax assertion.

Returns:

The name of this syntax assertion.

setParameter

void setParameter(SyntaxParameterName name,
                  java.lang.String value)

Sets a parameter's value for this syntax assertion.

Parameters:

name - The name of the parameter.

value - The value of the parameter.

getParameter

java.lang.String getParameter(SyntaxParameterName name)

Gets the value of a parameter in this syntax assertion.

Parameters:

name - The name of the parameter.

Returns:

The value of the parameter. If it is not set, it returns the default value.

removeParameter

java.lang.String removeParameter(SyntaxParameterName name)

Removes a parameter from this syntax assertion, setting its value back to the default value.

Parameters:

name - The name of the parameter.

Returns:

The value of the parameter before being removed.