*** This interface provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.storedprocess
Interface OutputParameterInterface

public interface OutputParameterInterface

This interface describes an output parameter. Output parameters can be obtained both from StoredProcess2Interface and from Execution2Interface. Both interfaces provide methods to return a single output parameter by name or a list of all output parameters.

Since:

9.2

Field Summary

static java.lang.String	TYPE_DATE
static java.lang.String	TYPE_DOUBLE
static java.lang.String	TYPE_INTEGER
static java.lang.String	TYPE_STRING
static java.lang.String	TYPE_TIME
static java.lang.String	TYPE_TIMESTAMP

Method Summary

java.lang.String	getDescription() Returns the description.
java.lang.String	getLabel() Returns the label.
java.lang.String	getName() Returns the name of the output parameter.
java.lang.String	getStringValue() Returns the string representation of the output parameter.
java.lang.String	getType() Returns the type of the output parameter.
java.lang.Object	getTypedValue() Returns the typed value.
boolean	isTypedValueValid() Specifies whether a typed value can be obtained using getTypedValue().

Field Detail

TYPE_DATE

static final java.lang.String TYPE_DATE

See Also:

Constant Field Values

TYPE_DOUBLE

static final java.lang.String TYPE_DOUBLE

See Also:

Constant Field Values

TYPE_INTEGER

static final java.lang.String TYPE_INTEGER

See Also:

Constant Field Values

TYPE_TIME

static final java.lang.String TYPE_TIME

See Also:

Constant Field Values

TYPE_TIMESTAMP

static final java.lang.String TYPE_TIMESTAMP

See Also:

Constant Field Values

TYPE_STRING

static final java.lang.String TYPE_STRING

See Also:

Constant Field Values

Method Detail

getDescription

java.lang.String getDescription()

Returns the description.

getLabel

java.lang.String getLabel()

Returns the label.

getName

java.lang.String getName()

Returns the name of the output parameter.

getType

java.lang.String getType()

Returns the type of the output parameter. The type is one of

• TYPE_DATE
• TYPE_DOUBLE
• TYPE_INTEGER
• TYPE_TIME
• TYPE_TIMESTAMP
• TYPE_STRING

getTypedValue

java.lang.Object getTypedValue()

Returns the typed value. If the value returned from the stored process cannot be converted to a Java object corresponding to the type returned by getType(), this method will return null.

Returns:

the typed value

getStringValue

java.lang.String getStringValue()

Returns the string representation of the output parameter. What is returned is the value assigned to the corresponding macro variable without any conversion.

Returns:

the string representation of the output parameter

isTypedValueValid

boolean isTypedValueValid()

Specifies whether a typed value can be obtained using getTypedValue(). If the value returned from the stored process cannot be converted to a Java object corresponding to the type returned by getType(), this method will return false; otherwise, true is returned.

Returns:

whether a typed value is obtainable

*** This interface provides Binary Compatibility only, not Source Compatibility ***