com.attachmate.vhi.resource.client
Class InteractionSpecImpl

java.lang.Object
  extended by com.attachmate.vhi.resource.client.InteractionSpecImpl
All Implemented Interfaces:
java.io.Serializable, javax.resource.cci.InteractionSpec

public class InteractionSpecImpl
extends java.lang.Object
implements javax.resource.cci.InteractionSpec, java.io.Serializable

Parameter for executing procedures in a CCI interaction.

Author:
KarlUp
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface javax.resource.cci.InteractionSpec
SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE
 
Constructor Summary
InteractionSpecImpl()
          Default constructor.
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
          Adds a new listener for bound properties.
 long getExecutionTimeout()
          The number of milliseconds an Interaction will wait for VHI to execute the specified function.
 int getFetchSize()
          The number of rows to return.
 boolean getFilterCaseSensitive()
          Specifies whether filter parameters are case sensitive.
 java.lang.String getFunctionName()
          Name of the procedure to execute.
 int getInteractionVerb()
          Mode for this interaction with VHI.
 java.util.List getOutputColumnNames()
          Specifies the output column names to return from this interaction.
 void removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
          Removes a listener from bound properties.
 void setExecutionTimeout(long executionTimeout)
          The number of milliseconds an Interaction will wait for VHI to execute the specified function.
 void setFetchSize(int fetchSize)
          The number of rows to return.
 void setFilterCaseSensitive(boolean filterCaseSensitive)
          Specifies whether filter parameters are case sensitive.
 void setFunctionName(java.lang.String functionName)
          Name of the procedure to execute.
 void setInteractionVerb(int interactionVerb)
          Mode for this interaction with VHI.
 void setOutputColumnNames(java.util.List outputColumnNames)
          Specifies the output column names to return from this interaction.
 java.lang.String toString()
          Returns a representation of the object as a string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

InteractionSpecImpl

public InteractionSpecImpl()
Default constructor.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
Adds a new listener for bound properties.

Parameters:
pcl - the listener to add.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
Removes a listener from bound properties.

Parameters:
pcl - the listener to remove.

setFunctionName

public void setFunctionName(java.lang.String functionName)
Name of the procedure to execute. The name must be the fully qualified table-name.procedure-name.

Parameters:
functionName - of the user-defined VHI procedure or the predefined system procedure vhi.sp_passivate to execute.

getFunctionName

public java.lang.String getFunctionName()
Name of the procedure to execute. The name must be the fully qualified table-name.procedure-name.

Returns:
functionName of the user-defined VHI procedure or the predefined system procedure vhi.sp_passivate to execute.

setInteractionVerb

public void setInteractionVerb(int interactionVerb)
Mode for this interaction with VHI.

Parameters:
interactionVerb - one of the SYNC_* constants. Only SYNC_SEND_RECEIVE is supported in VHI. The execution of an Interaction sends a request to the VHI server and receives the response synchronously.

getInteractionVerb

public int getInteractionVerb()
Mode for this interaction with VHI.

Returns:
one of the SYNC_* constants. Only SYNC_SEND_RECEIVE is supported in VHI. The execution of an Interaction sends a request to the VHI server and receives response synchronously.

setExecutionTimeout

public void setExecutionTimeout(long executionTimeout)
The number of milliseconds an Interaction will wait for VHI to execute the specified function.

Parameters:
executionTimeout - in milliseconds. Zero means wait indefinitely.

getExecutionTimeout

public long getExecutionTimeout()
The number of milliseconds an Interaction will wait for VHI to execute the specified function.

Returns:
execution timeout in milliseconds. Zero means wait indefinitely.

setFetchSize

public void setFetchSize(int fetchSize)
The number of rows to return.

Parameters:
fetchSize - the number of rows to return. Zero means unlimited.

getFetchSize

public int getFetchSize()
The number of rows to return.

Returns:
the number of rows to return. Zero means unlimited.

setFilterCaseSensitive

public void setFilterCaseSensitive(boolean filterCaseSensitive)
Specifies whether filter parameters are case sensitive.

Parameters:
filterCaseSensitive - true if filters are case sensitive.

getFilterCaseSensitive

public boolean getFilterCaseSensitive()
Specifies whether filter parameters are case sensitive.

Returns:
true if filters are case sensitive. Defaults to false.

setOutputColumnNames

public void setOutputColumnNames(java.util.List outputColumnNames)
Specifies the output column names to return from this interaction.

Parameters:
outputColumnNames - to return. Null means return all columns.

getOutputColumnNames

public java.util.List getOutputColumnNames()
Specifies the output column names to return from this interaction.

Returns:
output column names to return. Null means return all columns.

toString

public java.lang.String toString()
Returns a representation of the object as a string.

Overrides:
toString in class java.lang.Object
Returns:
a representation of the object as a string.


Copyright © 2008 Attachmate Corporation. All Rights Reserved.