7.0 Action Request System Java API

com.remedy.arsys.api
Class CharMenuQueryInfo

java.lang.Object
  extended bycom.remedy.arsys.api.CharMenuInfo
      extended bycom.remedy.arsys.api.CharMenuQueryInfo
All Implemented Interfaces:
java.lang.Cloneable

public class CharMenuQueryInfo
extends CharMenuInfo
implements java.lang.Cloneable

The CharMenuQueryInfo class returns information for query menus.


Field Summary
 
Fields inherited from class com.remedy.arsys.api.CharMenuInfo
DD, FILE, LIST, NONE, QUERY, SQL, SS
 
Constructor Summary
protected CharMenuQueryInfo()
           
  CharMenuQueryInfo(NameID schema, ServerNameID server, QualifierInfo qualifier, FieldID[] labelField, FieldID valueField, boolean sort, NameID sampleSchema, ServerNameID sampleServer)
           
  CharMenuQueryInfo(NameID schema, ServerNameID server, QualifierInfo qualifier, FieldID labelField, FieldID valueField, boolean sort, NameID sampleSchema, ServerNameID sampleServer)
           
 
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.
 FieldID[] getLabelField()
          Returns label of field used in query menu.
 QualifierInfo getQualification()
          Returns qualification for query menu.
 NameID getSampleSchema()
          Returns the sample schema name.
 ServerNameID getSampleServer()
          Returns the sample server name.
 NameID getSchema()
          Returns schema where query menu is attached.
 ServerNameID getServer()
          Returns server where query menu is located.
 boolean getSortOnLabel()
          Returns whether query menu sorts on label or not.
 FieldID getValueField()
          Returns value of field used in query menu.
 int hashCode()
          Returns the hash code value for this instance of the current class.
 
Methods inherited from class com.remedy.arsys.api.CharMenuInfo
getMenuType
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CharMenuQueryInfo

protected CharMenuQueryInfo()

CharMenuQueryInfo

public CharMenuQueryInfo(NameID schema,
                         ServerNameID server,
                         QualifierInfo qualifier,
                         FieldID labelField,
                         FieldID valueField,
                         boolean sort,
                         NameID sampleSchema,
                         ServerNameID sampleServer)

CharMenuQueryInfo

public CharMenuQueryInfo(NameID schema,
                         ServerNameID server,
                         QualifierInfo qualifier,
                         FieldID[] labelField,
                         FieldID valueField,
                         boolean sort,
                         NameID sampleSchema,
                         ServerNameID sampleServer)
Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Description copied from class: CharMenuInfo
Clone implementation that returns an Object with data cloned from self.

Overrides:
clone in class CharMenuInfo
Throws:
java.lang.CloneNotSupportedException

getSchema

public NameID getSchema()
Returns schema where query menu is attached.


getServer

public ServerNameID getServer()
Returns server where query menu is located.


getQualification

public QualifierInfo getQualification()
Returns qualification for query menu.


getLabelField

public FieldID[] getLabelField()
Returns label of field used in query menu.


getValueField

public FieldID getValueField()
Returns value of field used in query menu.


getSortOnLabel

public boolean getSortOnLabel()
Returns whether query menu sorts on label or not.


getSampleSchema

public NameID getSampleSchema()
Returns the sample schema name. This is used by the authoring environment when the schema is a reference to a value rather than an actual form name.


getSampleServer

public ServerNameID 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(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 CharMenuInfo

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 CharMenuInfo

7.0 Action Request System Java API