com.bmc.arsys.api

Class QueryMenu

java.lang.Object

com.bmc.arsys.api.ObjectBase

com.bmc.arsys.api.Menu

com.bmc.arsys.api.ServerInfoMenu

com.bmc.arsys.api.QueryMenu

All Implemented Interfaces:

IARPersistentObject, Serializable, Cloneable

public class QueryMenu
extends ServerInfoMenu
implements Cloneable, Serializable

The QueryMenu class returns information for query menus.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueryMenu(String form, String server, QualifierInfo qualifier, int labelField, int valueField, boolean sort, String sampleForm, String sampleServer)
QueryMenu(String form, String server, QualifierInfo qualifier, List<Integer> labelField, int valueField, boolean sort, String sampleForm, String sampleServer)

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.
String	getForm() Returns form where query menu is attached.
List<Integer>	getLabelField() Returns label of field used in query menu.
QualifierInfo	getQualification() Returns qualification for query menu.
String	getSampleForm() Returns the sample form name.
String	getSampleServer() Returns the sample server name.
int	getValueField() Returns value of field used in query menu.
int	hashCode() Returns the hash code value for this instance of the current class.
boolean	isSortOnLabel() Returns whether query menu sorts on label or not.
void	setForm(String form) Sets the form name.
void	setLabelField(List<Integer> labelFields) Sets label of field used in query menu.
void	setQualification(QualifierInfo quaInfo) Sets qualification for query menu.
void	setSampleForm(String sampleForm) Sets the sample form name.
void	setSampleServer(String sampleServer) Sets the sample server name.
void	setServer(String server) Sets the server name.
void	setSortOnLabel(boolean sortOnLabel) Sets whether query menu sorts on label or not.
void	setValueField(int valueField) Sets value of field used in query menu.
String	toString() Returns a string description of the object.

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

getServer

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

QueryMenu

public QueryMenu(String form,
                 String server,
                 QualifierInfo qualifier,
                 int labelField,
                 int valueField,
                 boolean sort,
                 String sampleForm,
                 String sampleServer)

QueryMenu

public QueryMenu(String form,
                 String server,
                 QualifierInfo qualifier,
                 List<Integer> labelField,
                 int valueField,
                 boolean sort,
                 String sampleForm,
                 String sampleServer)

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

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

Overrides:

clone in class ServerInfoMenu

Throws:

CloneNotSupportedException

getForm

public String getForm()

Returns form where query menu is attached.

getQualification

public QualifierInfo getQualification()

Returns qualification for query menu.

getLabelField

public List<Integer> getLabelField()

Returns label of field used in query menu.

getValueField

public int getValueField()

Returns value of field used in query menu.

isSortOnLabel

public boolean isSortOnLabel()

Returns whether query menu sorts on label or not.

getSampleForm

public String getSampleForm()

Returns the sample form name. This is used by the authoring environment when the form is a reference to a value rather than an actual form name.

getSampleServer

public String getSampleServer()

Returns the sample server name. This is used by the authoring environment when the server is a reference to a value rather than an actual form name.

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 ServerInfoMenu

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 ServerInfoMenu

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class ServerInfoMenu

setQualification

public void setQualification(QualifierInfo quaInfo)

Sets qualification for query menu.

setLabelField

public void setLabelField(List<Integer> labelFields)

Sets label of field used in query menu.

setValueField

public void setValueField(int valueField)

Sets value of field used in query menu.

setSortOnLabel

public void setSortOnLabel(boolean sortOnLabel)

Sets whether query menu sorts on label or not.

setSampleForm

public void setSampleForm(String sampleForm)

Sets the sample form name. This is used by the authoring environment when the form is a reference to a value rather than an actual form name.

setSampleServer

public void setSampleServer(String sampleServer)

Sets the sample server name. This is used by the authoring environment when the server is a reference to a value rather than an actual form name.

setForm

public void setForm(String form)

Sets the form name.

setServer

public void setServer(String server)

Sets the server name.