com.sun.slamd.scripting.engine
Interface Argument

All Known Implementing Classes:

BooleanLiteral, BooleanVariable, CategoricalTrackerVariable, FileURLVariable, HTMLDocumentVariable, HTTPClientVariable, HTTPRequestVariable, HTTPResponseVariable, IMAPConnectionVariable, IncrementalTrackerVariable, IntegerLiteral, IntegerValueTrackerVariable, IntegerVariable, JDBCConnectionVariable, JDBCPreparedStatementVariable, JDBCResultSetVariable, LDAPAttributeVariable, LDAPConnectionVariable, LDAPEntryVariable, LDAPModificationSetVariable, LDAPModificationVariable, LDAPUtilsVariable, MailMessageVariable, MethodCallInstruction, POPConnectionVariable, RateLimiterVariable, ScriptVariable, SMTPConnectionVariable, StringArrayVariable, StringLiteral, StringVariable, TFTPClientVariable, TimeTrackerVariable, ValuePatternVariable, Variable

public interface Argument

This interface defines a set of methods that are required to be implemented by any script element that may be a parameter to a script method.

Author:

Neil A. Wilson

Method Summary

java.lang.String	getArgumentAsString() Retrieves a string representation of this argument in a form appropriate for inclusion in a script.
java.lang.String	getArgumentType() Retrieves the name of the data type associated with this argument.
Variable	getArgumentValue() Retrieves the value of this argument.
java.lang.String	getValueAsString() Retrieves a string representation of the value of this argument.

Method Detail

getArgumentType

java.lang.String getArgumentType()

Retrieves the name of the data type associated with this argument.

Returns:

The name of the data type associated with this argument.

getArgumentValue

Variable getArgumentValue()
                          throws ScriptException

Retrieves the value of this argument.

Returns:

The value of this argument.

Throws:

ScriptException - If a problem occurs while determining the value of this argument.

getArgumentAsString

java.lang.String getArgumentAsString()

Retrieves a string representation of this argument in a form appropriate for inclusion in a script.

Returns:

A string representation of this argument in a form appropriate for inclusion in a script.

getValueAsString

java.lang.String getValueAsString()
                                  throws ScriptException

Retrieves a string representation of the value of this argument.

Returns:

A string representation of the value of this argument.

Throws:

ScriptException - If a problem occurs while retrieving the value as a string.