com.bmc.arsys.api
Class CallGuideAction

java.lang.Object
  com.bmc.arsys.api.Action
      com.bmc.arsys.api.CallGuideAction

All Implemented Interfaces:

ActiveLinkAction, FilterAction, Serializable, Cloneable

public class CallGuideAction
extends Action
implements ActiveLinkAction, FilterAction, Cloneable, Serializable

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

See Also:

Serialized Form

Constructor Summary

CallGuideAction()

CallGuideAction(String serverName, String guideName, int guideMode, int guideTableId, List<FieldAssignInfo> inputValueFieldPairs, List<FieldAssignInfo> outputValueFieldPairs, String sampleServer, String sampleGuide)

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	getGuideMode() Reserved for future use.
String	getGuideName() Returns name of guide.
int	getGuideTableId() Reserved for future use.
List<FieldAssignInfo>	getInputValueFieldPairs() Returns field/value pair for values that users enter into Dialog/Search/Submit windows.
List<FieldAssignInfo>	getOutputValueFieldPairs() Returns field/value pair for output values from Dialog/Search/Submit windows.
String	getSampleGuide() Returns name of sample guide.
String	getSampleServer() Returns name of sample server.
String	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(String guideName) Sets name of guide.
void	setGuideTableId(int guideTableId) Reserved for future use.
void	setInputValueFieldPairs(List<FieldAssignInfo> inputValueFieldPairs) Field/value pair for values that users enter into Dialog/Search/Submit windows.
void	setOutputValueFieldPairs(List<FieldAssignInfo> outputValueFieldPairs) Field/value pair for output values from Dialog/Search/Submit windows.
void	setSampleGuide(String sampleGuideName) Sets name of sample guide.
void	setSampleServer(String sampleServerName) Sets name of sample server.
void	setServerName(String serverName) Sets name of server.
String	toString() Returns a string description of the object.

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

equals, getActionType

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CallGuideAction

public CallGuideAction()

CallGuideAction

public CallGuideAction(String serverName,
                       String guideName,
                       int guideMode,
                       int guideTableId,
                       List<FieldAssignInfo> inputValueFieldPairs,
                       List<FieldAssignInfo> outputValueFieldPairs,
                       String sampleServer,
                       String sampleGuide)

Method Detail

getServerName

public String getServerName()

Returns name of server.

setServerName

public void setServerName(String serverName)

Sets name of server.

getGuideName

public String getGuideName()

Returns name of guide.

setGuideName

public void setGuideName(String 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 int getGuideTableId()

Reserved for future use.

setGuideTableId

public void setGuideTableId(int guideTableId)

Reserved for future use.

getInputValueFieldPairs

public List<FieldAssignInfo> getInputValueFieldPairs()

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

setInputValueFieldPairs

public void setInputValueFieldPairs(List<FieldAssignInfo> inputValueFieldPairs)

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

getOutputValueFieldPairs

public List<FieldAssignInfo> getOutputValueFieldPairs()

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

setOutputValueFieldPairs

public void setOutputValueFieldPairs(List<FieldAssignInfo> outputValueFieldPairs)

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

getSampleServer

public String getSampleServer()

Returns name of sample server.

setSampleServer

public void setSampleServer(String sampleServerName)

Sets name of sample server.

getSampleGuide

public String getSampleGuide()

Returns name of sample guide.

setSampleGuide

public void setSampleGuide(String sampleGuideName)

Sets name of sample guide.

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class Action

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 Action

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 Action

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Action