com.bmc.arsys.api
Class AssignSQLInfo

java.lang.Object
  com.bmc.arsys.api.AssignSQLInfo

All Implemented Interfaces:

Serializable, Cloneable

public class AssignSQLInfo
extends Object
implements Cloneable, Serializable

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

See Also:

Serialized Form

Constructor Summary

AssignSQLInfo()
constructor

AssignSQLInfo(String server, String sqlCommand, int valueIndex, int noMatchOption, int multiMatchOption)

Method Summary

Object	clone() Clone implementation that returns an Object with data cloned from self
boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
int	getMultiMatchOption()
int	getNoMatchOption()
String	getServer() Returns string specifying the name of the server where the database is located.
String	getSqlCommand() Returns string specifying the SQL query to execute.
int	getValueIndex() Returns integer value indicating which of the selected columns contains the value to assign.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setMultiMatchOption(int multiMatchOption) Sets integer value indicating the action to take if multiple rows match the selection criteria.
void	setNoMatchOption(int noMatchOption) Sets integer value indicating the action to take if no rows match the selection criteria.
void	setServer(String server) Sets string specifying the name of the server where the database is located.
void	setSqlCommand(String sqlCommand) Sets string specifying the SQL query to execute.
void	setValueIndex(int valueIndex) Sets integer value indicating which of the selected columns contains the value to assign.
String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AssignSQLInfo

public AssignSQLInfo()

constructor

AssignSQLInfo

public AssignSQLInfo(String server,
                     String sqlCommand,
                     int valueIndex,
                     int noMatchOption,
                     int multiMatchOption)

Method Detail

getServer

public String getServer()

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

setServer

public void setServer(String server)

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

getSqlCommand

public String getSqlCommand()

Returns string specifying the SQL query to execute.

setSqlCommand

public void setSqlCommand(String sqlCommand)

Sets string specifying the SQL query to execute.

getValueIndex

public int getValueIndex()

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

setValueIndex

public void setValueIndex(int valueIndex)

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

getNoMatchOption

public int 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:

• AR_NO_MATCH_ERROR
• AR_NO_MATCH_SET_NULL
• AR_NO_MATCH_NO_ACTION
• AR_NO_MATCH_SUBMIT

setNoMatchOption

public void setNoMatchOption(int noMatchOption)

Sets integer value indicating the action to take if no rows match the selection criteria.

Parameters:

noMatchOption - The possible constant values that this method can set are:

• AR_NO_MATCH_ERROR
• AR_NO_MATCH_SET_NULL
• AR_NO_MATCH_NO_ACTION
• AR_NO_MATCH_SUBMIT

getMultiMatchOption

public int 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:

• AR_MULTI_MATCH_ERROR
• AR_MULTI_MATCH_SET_NULL
• AR_MULTI_MATCH_USE_FIRST
• AR_MULTI_MATCH_PICKLIST
• AR_MULTI_MATCH_MODIFY_ALL
• AR_MULTI_MATCH_NO_ACTION

setMultiMatchOption

public void setMultiMatchOption(int multiMatchOption)

Sets integer value indicating the action to take if multiple rows match the selection criteria.

Parameters:

multiMatchOption - The possible constant values that this method can set are:

• AR_MULTI_MATCH_ERROR
• AR_MULTI_MATCH_SET_NULL
• AR_MULTI_MATCH_USE_FIRST
• AR_MULTI_MATCH_PICKLIST
• AR_MULTI_MATCH_MODIFY_ALL
• AR_MULTI_MATCH_NO_ACTION

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

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

Overrides:

equals in class Object

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class Object

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Object