com.remedy.arsys.api
Class CallGuideInfo

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

All Implemented Interfaces:

java.lang.Cloneable

public class CallGuideInfo

extends java.lang.Object

implements java.lang.Cloneable

The CallGuideInfo class is used to represent information about the Call Guide active link action.

Constructor Summary

CallGuideInfo()

CallGuideInfo(java.lang.String serverName, java.lang.String guideName, int guideMode, FieldID guideTableId, FieldAssignInfo[] inputValueFieldPairs, FieldAssignInfo[] outputValueFieldPairs, java.lang.String sampleServer, java.lang.String sampleGuide)

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.
int	getGuideMode() Reserved for future use.
NameID	getGuideName() Returns name of guide.
FieldID	getGuideTableId() Reserved for future use.
FieldAssignInfo[]	getInputValueFieldPairs() Returns field/value pair for values that users enter into Dialog/Search/Submit windows.
FieldAssignInfo[]	getOutputValueFieldPairs() Returns field/value pair for output values from Dialog/Search/Submit windows.
NameID	getSampleGuide() Returns name of sample guide.
ServerNameID	getSampleServer() Returns name of sample server.
ServerNameID	getServerName() Returns name of server.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setGuideMode(int guideMode) Reserved for future use.
void	setGuideName(NameID guideName) Sets name of guide.
void	setGuideTableId(FieldID guideTableId) Reserved for future use.
void	setInputValueFieldPairs(FieldAssignInfo[] inputValueFieldPairs) Field/value pair for values that users enter into Dialog/Search/Submit windows.
void	setOutputValueFieldPairs(FieldAssignInfo[] outputValueFieldPairs) Field/value pair for output values from Dialog/Search/Submit windows.
void	setSampleGuide(NameID sampleGuideName) Sets name of sample guide.
void	setSampleServer(ServerNameID sampleServerName) Sets name of sample server.
void	setServerName(ServerNameID serverName) Sets name of server.

Methods inherited from class java.lang.Object

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

Constructor Detail

CallGuideInfo

public CallGuideInfo()

CallGuideInfo

public CallGuideInfo(java.lang.String serverName,
                     java.lang.String guideName,
                     int guideMode,
                     FieldID guideTableId,
                     FieldAssignInfo[] inputValueFieldPairs,
                     FieldAssignInfo[] outputValueFieldPairs,
                     java.lang.String sampleServer,
                     java.lang.String sampleGuide)

Method Detail

getServerName

public ServerNameID getServerName()

Returns name of server.

setServerName

public void setServerName(ServerNameID serverName)

Sets name of server.

getGuideName

public NameID getGuideName()

Returns name of guide.

setGuideName

public void setGuideName(NameID guideName)

Sets name of guide.

getGuideMode

public int getGuideMode()

Reserved for future use.

setGuideMode

public void setGuideMode(int guideMode)

Reserved for future use.

getGuideTableId

public FieldID getGuideTableId()

Reserved for future use.

setGuideTableId

public void setGuideTableId(FieldID guideTableId)

Reserved for future use.

getInputValueFieldPairs

public FieldAssignInfo[] getInputValueFieldPairs()

Returns field/value pair for values that users enter into Dialog/Search/Submit windows.

setInputValueFieldPairs

public void setInputValueFieldPairs(FieldAssignInfo[] inputValueFieldPairs)

Field/value pair for values that users enter into Dialog/Search/Submit windows. Method will not return value.

getOutputValueFieldPairs

public FieldAssignInfo[] getOutputValueFieldPairs()

Returns field/value pair for output values from Dialog/Search/Submit windows.

setOutputValueFieldPairs

public void setOutputValueFieldPairs(FieldAssignInfo[] outputValueFieldPairs)

Field/value pair for output values from Dialog/Search/Submit windows. Method will not return value.

getSampleServer

public ServerNameID getSampleServer()

Returns name of sample server.

setSampleServer

public void setSampleServer(ServerNameID sampleServerName)

Sets name of sample server.

getSampleGuide

public NameID getSampleGuide()

Returns name of sample guide.

setSampleGuide

public void setSampleGuide(NameID sampleGuideName)

Sets name of sample guide.

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 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()

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 java.lang.Object