com.remedy.arsys.api
Class AssignSQLInfo

java.lang.Object
  |
  +--com.remedy.arsys.api.AssignSQLInfo

All Implemented Interfaces:

java.lang.Cloneable

public class AssignSQLInfo

extends java.lang.Object

implements java.lang.Cloneable

The AssignSQLInfo class specifies the SQL command and how the result is assigned to the field in a Set Fields action.

Constructor Summary

AssignSQLInfo()
constructor

AssignSQLInfo(java.lang.String server, java.lang.String sqlCommand, long valueIndex, long noMatchOption, long multiMatchOption)

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self
boolean	equals(java.lang.Object anObject) Use this method for checking equality.
long	getMultiMatchOption() Returns integer value indicating the action to take if multiple rows match the selection criteria.
long	getNoMatchOption() Returns integer value indicating the action to take if no rows match the selection criteria.
java.lang.String	getServer() Returns string specifying the name of the server where the database is located.
java.lang.String	getSqlCommand() Returns string specifying the SQL query to execute.
long	getValueIndex() Returns integer value indicating which of the selected columns contains the value to assign.
int	hashCode() This method can be used to populate a hash table.
void	setMultiMatchOption(long multiMatchOption) Sets integer value indicating the action to take if multiple rows match the selection criteria.
void	setNoMatchOption(long noMatchOption) Sets integer value indicating the action to take if no rows match the selection criteria.
void	setServer(java.lang.String server) Sets string specifying the name of the server where the database is located.
void	setSqlCommand(java.lang.String sqlCommand) Sets string specifying the SQL query to execute.
void	setValueIndex(long valueIndex) Sets integer value indicating which of the selected columns contains the value to assign.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssignSQLInfo

public AssignSQLInfo()

constructor

AssignSQLInfo

public AssignSQLInfo(java.lang.String server,
                     java.lang.String sqlCommand,
                     long valueIndex,
                     long noMatchOption,
                     long multiMatchOption)

Method Detail

getServer

public java.lang.String getServer()

Returns string specifying the name of the server where the database is located.

setServer

public void setServer(java.lang.String server)

Sets string specifying the name of the server where the database is located.

getSqlCommand

public java.lang.String getSqlCommand()

Returns string specifying the SQL query to execute.

setSqlCommand

public void setSqlCommand(java.lang.String sqlCommand)

Sets string specifying the SQL query to execute.

getValueIndex

public long getValueIndex()

Returns integer value indicating which of the selected columns contains the value to assign.

setValueIndex

public void setValueIndex(long valueIndex)

Sets integer value indicating which of the selected columns contains the value to assign.

getNoMatchOption

public long getNoMatchOption()

Returns integer value indicating the action to take if no rows match the selection criteria. The possible constant values that this method can return are:

Parameters:

AR_NO_MATCH_ERROR - AR_NO_MATCH_ERROR

AR_NO_MATCH_SET_NULL - AR_NO_MATCH_SET_NULL

AR_NO_MATCH_NO_ACTION - AR_NO_MATCH_NO_ACTION

AR_NO_MATCH_SUBMIT - AR_NO_MATCH_SUBMIT

setNoMatchOption

public void setNoMatchOption(long noMatchOption)

Sets integer value indicating the action to take if no rows match the selection criteria. The possible constant values that this method can set are:

Parameters:

AR_NO_MATCH_ERROR - AR_NO_MATCH_ERROR

AR_NO_MATCH_SET_NULL - AR_NO_MATCH_SET_NULL

AR_NO_MATCH_NO_ACTION - AR_NO_MATCH_NO_ACTION

AR_NO_MATCH_SUBMIT - AR_NO_MATCH_SUBMIT

getMultiMatchOption

public long getMultiMatchOption()

Returns integer value indicating the action to take if multiple rows match the selection criteria. The possible constant values that this method can return are:

Parameters:

AR_MULTI_MATCH_ERROR - AR_MULTI_MATCH_ERROR

AR_MULTI_MATCH_SET_NULL - AR_MULTI_MATCH_SET_NULL

AR_MULTI_MATCH_USE_FIRST - AR_MULTI_MATCH_USE_FIRST

AR_MULTI_MATCH_PICKLIST - AR_MULTI_MATCH_PICKLIST

AR_MULTI_MATCH_MODIFY_ALL - AR_MULTI_MATCH_MODIFY_ALL

AR_MULTI_MATCH_NO_ACTION - AR_MULTI_MATCH_NO_ACTION

setMultiMatchOption

public void setMultiMatchOption(long multiMatchOption)

Sets integer value indicating the action to take if multiple rows match the selection criteria. The possible constant values that this method can set are:

Parameters:

AR_MULTI_MATCH_ERROR - AR_MULTI_MATCH_ERROR

AR_MULTI_MATCH_SET_NULL - AR_MULTI_MATCH_SET_NULL

AR_MULTI_MATCH_USE_FIRST - AR_MULTI_MATCH_USE_FIRST

AR_MULTI_MATCH_PICKLIST - AR_MULTI_MATCH_PICKLIST

AR_MULTI_MATCH_MODIFY_ALL - AR_MULTI_MATCH_MODIFY_ALL

AR_MULTI_MATCH_NO_ACTION - AR_MULTI_MATCH_NO_ACTION

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object anObject)

Use this method for checking equality. The result is true if and only if the argument is not null, is of same type and represents the same content.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

This method can be used to populate a hash table. Implicitly used method to test equality of objects.

Overrides:

hashCode in class java.lang.Object