gov.virginia.dcjs.standards.gui
Class Path

java.lang.Object
  gov.virginia.dcjs.standards.gui.Path

public class Path

extends java.lang.Object

This class maintains the simplest path of a user has * taken to get to their present destination in the TRex system. It assists * in helping to determine the present state when backtracking.

Field Summary

static int	ACADEMY Constant to represent an Academy list visitation.
static int	AGENCY Constant to represent an Agency list visitation.

Constructor Summary

Path()

Path(java.lang.String root)

Method Summary

void	clear() Reset the path information to begin afresh.
void	clearAgency() Reset the agency data portion of the path.
java.lang.String	getParentID() Obtain the ID of the last selected entity on the path.
java.lang.String	getParentName() Obtain the name of the last selected entity on the path.
java.lang.String	getPath() Obtain the path as currently expressed by the present data.
void	set(int type, java.lang.String id, java.lang.String name) Notification that the user has moved from the specified state * having the data provided.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACADEMY

public static final int ACADEMY

Constant to represent an Academy list visitation.

See Also:

Constant Field Values

AGENCY

public static final int AGENCY

Constant to represent an Agency list visitation.

See Also:

Constant Field Values

Constructor Detail

Path

public Path()

Path

public Path(java.lang.String root)

Method Detail

set

public void set(int type,
                java.lang.String id,
                java.lang.String name)

Notification that the user has moved from the specified state * having the data provided. * @param type State type constant, one of {ACADEMY, AGENCY}. * @param id Agency ID of the academy or agency selected in the just * departed list. * @param name Academy or Agency name selected in the list just departed.

clear

public void clear()

Reset the path information to begin afresh.

clearAgency

public void clearAgency()

Reset the agency data portion of the path.

getPath

public java.lang.String getPath()

Obtain the path as currently expressed by the present data. * @return Current path contained in this class, or simply the * root element if there is no path.

getParentID

public java.lang.String getParentID()

Obtain the ID of the last selected entity on the path. * @return Agency ID of the last selected entity on the path, * or null if there is no parent entity.

getParentName

public java.lang.String getParentName()

Obtain the name of the last selected entity on the path. * @return Name of the last selected entity on the path, * or null if there is no parent entity.