ConnectionParameter

Inheritance: java.lang.Object

public class ConnectionParameter

Specifies properties about any parameters used with external data connections Parameters are valid for ODBC and web queries.

Methods

Method	Description
equals(Object arg0)
getCellReference()	Cell reference indicating which cell’s value to use for the query parameter.
getClass()
getName()	The name of the parameter.
getPrompt()	Prompt string for the parameter.
getRefreshOnChange()	Flag indicating whether the query should automatically refresh when the contents of a cell that provides the parameter value changes.
getSqlType()	SQL data type of the parameter.
getType()	Type of parameter used.
getValue()	Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter.
hashCode()
notify()
notifyAll()
setCellReference(String value)	Cell reference indicating which cell’s value to use for the query parameter.
setName(String value)	The name of the parameter.
setPrompt(String value)	Prompt string for the parameter.
setRefreshOnChange(boolean value)	Flag indicating whether the query should automatically refresh when the contents of a cell that provides the parameter value changes.
setSqlType(int value)	SQL data type of the parameter.
setType(int value)	Type of parameter used.
setValue(Object value)	Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getCellReference()

public String getCellReference()

Cell reference indicating which cell’s value to use for the query parameter. Used only when parameterType is cell.

Returns: java.lang.String

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getName()

public String getName()

The name of the parameter.

Returns: java.lang.String

getPrompt()

public String getPrompt()

Prompt string for the parameter. Presented to the spreadsheet user along with input UI to collect the parameter value before refreshing the external data. Used only when parameterType = prompt.

Returns: java.lang.String

getRefreshOnChange()

public boolean getRefreshOnChange()

Flag indicating whether the query should automatically refresh when the contents of a cell that provides the parameter value changes. If true, then external data is refreshed using the new parameter value every time there’s a change. If false, then external data is only refreshed when requested by the user, or some other event triggers refresh (e.g., workbook opened).

Returns: boolean

getSqlType()

public int getSqlType()

SQL data type of the parameter. Only valid for ODBC sources.

See SqlDataType.

Returns: int

getType()

public int getType()

Type of parameter used. If the parameterType=value, then the value from boolean, double, integer, or string will be used. In this case, it is expected that only one of {boolean, double, integer, or string} will be specified.

See ConnectionParameterType.

Returns: int

getValue()

public Object getValue()

Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter. Used only when parameterType is value.

Returns: java.lang.Object

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setCellReference(String value)

public void setCellReference(String value)

Cell reference indicating which cell’s value to use for the query parameter. Used only when parameterType is cell.

Parameters:

Parameter	Type	Description
value	java.lang.String

setName(String value)

public void setName(String value)

The name of the parameter.

Parameters:

Parameter	Type	Description
value	java.lang.String

setPrompt(String value)

public void setPrompt(String value)

Prompt string for the parameter. Presented to the spreadsheet user along with input UI to collect the parameter value before refreshing the external data. Used only when parameterType = prompt.

Parameters:

Parameter	Type	Description
value	java.lang.String

setRefreshOnChange(boolean value)

public void setRefreshOnChange(boolean value)

Flag indicating whether the query should automatically refresh when the contents of a cell that provides the parameter value changes. If true, then external data is refreshed using the new parameter value every time there’s a change. If false, then external data is only refreshed when requested by the user, or some other event triggers refresh (e.g., workbook opened).

Parameters:

Parameter	Type	Description
value	boolean

setSqlType(int value)

public void setSqlType(int value)

SQL data type of the parameter. Only valid for ODBC sources.

See SqlDataType.

Parameters:

Parameter	Type	Description
value	int

setType(int value)

public void setType(int value)

Type of parameter used. If the parameterType=value, then the value from boolean, double, integer, or string will be used. In this case, it is expected that only one of {boolean, double, integer, or string} will be specified.

See ConnectionParameterType.

Parameters:

Parameter	Type	Description
value	int

setValue(Object value)

public void setValue(Object value)

Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter. Used only when parameterType is value.

Parameters:

Parameter	Type	Description
value	java.lang.Object

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int