AR System Java API

com.bmc.arsys.api
Class ExitGuideAction

java.lang.Object
  extended by com.bmc.arsys.api.Action
      extended by com.bmc.arsys.api.ExitGuideAction
All Implemented Interfaces:
ActiveLinkAction, FilterAction, Serializable, Cloneable

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

The ExitGuideInfo class is used to create and retrieve information about the Exit Guide active link action. You use the Exit Guide action to terminate the current guide and, optionally, all of its calling guides. For more information, see the Developing AR System Applications: Basic guide.

See Also:
Serialized Form

Constructor Summary
ExitGuideAction()
          constructor
ExitGuideAction(boolean closeAll)
          Constructs a new ExitGuideInfo object using the closeAll parameter.
 
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.
 int hashCode()
          Returns the hash code value for this instance of the current class.
 boolean isCloseAll()
          Returns the flag that indicates whether all the guides should be closed or not.
 void setCloseAll(boolean closeAll)
          Sets the flag that indicates whether all the guides should be closed or not.
 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

ExitGuideAction

public ExitGuideAction()
constructor


ExitGuideAction

public ExitGuideAction(boolean closeAll)
Constructs a new ExitGuideInfo object using the closeAll parameter.

Parameters:
closeAll - The closeAll parameter sets the flag that indicates whether all the guides should be closed or not.
Method Detail

isCloseAll

public boolean isCloseAll()
Returns the flag that indicates whether all the guides should be closed or not.


setCloseAll

public void setCloseAll(boolean closeAll)
Sets the flag that indicates whether all the guides should be closed or not.


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. The result is true only if the argument is not null, is of 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()
Description copied from class: Action
Returns a string description of the object.

Overrides:
toString in class Action

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.