com.remedy.arsys.api
Class ExitGuideInfo

java.lang.Object
  com.remedy.arsys.api.ExitGuideInfo

All Implemented Interfaces:

java.lang.Cloneable

public class ExitGuideInfo

extends java.lang.Object

implements java.lang.Cloneable

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.

Constructor Summary

ExitGuideInfo()
constructor

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

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.
boolean	getCloseAll() Returns the flag that indicates whether all the guides should be closed or not.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setCloseAll(boolean closeAll) Sets the flag that indicates whether all the guides should be closed or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExitGuideInfo

public ExitGuideInfo()

constructor

ExitGuideInfo

public ExitGuideInfo(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

getCloseAll

public boolean getCloseAll()

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 java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

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

Throws:

java.lang.CloneNotSupportedException

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.

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.