com.bmc.arsys.api

Class SqlMenu

java.lang.Object

com.bmc.arsys.api.ObjectBase

com.bmc.arsys.api.Menu

com.bmc.arsys.api.SqlMenu

All Implemented Interfaces:

IARPersistentObject, Serializable, Cloneable

public class SqlMenu
extends Menu
implements Cloneable, Serializable

The SqlMenu class returns information for SQL menu.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SqlMenu(String server, String sqlCommand, int labelIndex, int valueIndex)
SqlMenu(String server, String sqlCommand, List<Integer> labelIndex, int valueIndex)

Method Summary

Modifier and Type	Method and Description
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.
List<Integer>	getLabelIndex() Returns numerical index of the database column that contains the information to display as the menu item label when user chooses the menu item.
String	getServer() Returns server where SQL menu is located.
String	getSQLCommand() Returns SQL command issued to the database that is used in SQL menu.
int	getValueIndex() Returns numerical index of the database column that contains the information to load in the field when user chooses the menu item.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setLabelIndex(List<Integer> index) Sets numerical index of the database column that contains the information to display as the menu item label when user chooses the menu item.
void	setServer(String server) Sets server where SQL menu is located.
void	setSQLCommand(String sqlCommand) Sets SQL command issued to the database that is used in SQL menu.
void	setValueIndex(int index) Sets numerical index of the database column that contains the information to load in the field when user chooses the menu item.
String	toString() Returns a string description of the object.

Methods inherited from class com.bmc.arsys.api.Menu

getContent, getKey, getMenuType, getProperties, getRefreshCode, setContent, setKey, setProperties, setRefreshCode

Methods inherited from class com.bmc.arsys.api.ObjectBase

appendDiaryText, clear, getChangeFlags, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, setChangeFlags, setDiary, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SqlMenu

public SqlMenu(String server,
               String sqlCommand,
               int labelIndex,
               int valueIndex)

SqlMenu

public SqlMenu(String server,
               String sqlCommand,
               List<Integer> labelIndex,
               int valueIndex)

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from class: Menu

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class Menu

Throws:

CloneNotSupportedException

getServer

public String getServer()

Returns server where SQL menu is located.

getSQLCommand

public String getSQLCommand()

Returns SQL command issued to the database that is used in SQL menu.

getLabelIndex

public List<Integer> getLabelIndex()

Returns numerical index of the database column that contains the information to display as the menu item label when user chooses the menu item.

getValueIndex

public int getValueIndex()

Returns numerical index of the database column that contains the information to load in the field when user chooses the menu item.

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 Menu

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 Menu

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Menu

setServer

public void setServer(String server)

Sets server where SQL menu is located.

setSQLCommand

public void setSQLCommand(String sqlCommand)

Sets SQL command issued to the database that is used in SQL menu.

setLabelIndex

public void setLabelIndex(List<Integer> index)

Sets numerical index of the database column that contains the information to display as the menu item label when user chooses the menu item.

setValueIndex

public void setValueIndex(int index)

Sets numerical index of the database column that contains the information to load in the field when user chooses the menu item.