Package hec.data.pool

Class PoolRef

java.lang.Object

hec.data.pool.PoolRef

public class PoolRef
extends Object

Represents the information required for retrieving IPool objects from the database.

Constructor Summary

Constructors

Constructor	Description
PoolRef(PoolNameRef poolNameRef)	Creates a PoolRef given a PoolNameRef instance.
PoolRef(PoolNameRef poolNameRef, String projectIdMask)	Creates a new PoolRef object given a PoolNameRef and the Project ID.
PoolRef(PoolNameRef poolNameRef, String projectIdMask, String bottomLevelMask, String topLevelMask)	Creates a new PoolRef given a PoolNameRef, Project ID mask, and Top and Bottom level masks.

Method Summary

Modifier and Type	Method	Description
static PoolRef	all()	Creates a new PoolRef that can be used to retrieve all pools.
boolean	equals(Object obj)
String	getBottomLevelMask()	Returns the glob style Bottom Location Level Mask for this pool ref.
PoolNameRef	getPoolNameRef()	Returns the PoolNameRef instance for this pool ref.
String	getProjectIdMask()	Returns the glob style Project ID mask for this pool ref.
String	getTopLevelMask()	Returns the glob style Top Location Level Mask for this pool ref.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Details

PoolRef

public PoolRef(PoolNameRef poolNameRef,
 String projectIdMask,
 String bottomLevelMask,
 String topLevelMask)

Creates a new PoolRef given a PoolNameRef, Project ID mask, and Top and Bottom level masks.

Parameters:

poolNameRef -

projectIdMask -

bottomLevelMask -

topLevelMask -

PoolRef

public PoolRef(PoolNameRef poolNameRef,
 String projectIdMask)

Creates a new PoolRef object given a PoolNameRef and the Project ID. The top and bottom location levels are set to "*" masks.

Parameters:

poolNameRef - PoolName information for retrieval

projectIdMask - Project ID mask

PoolRef

public PoolRef(PoolNameRef poolNameRef)

Creates a PoolRef given a PoolNameRef instance. The Project ID, top and bottom location levels are set to "*" masks.

Parameters:

poolNameRef -

Method Details

all

public static PoolRef all()

Creates a new PoolRef that can be used to retrieve all pools.

Returns:

New PoolRef for retrieving all Pools.

getPoolNameRef

public PoolNameRef getPoolNameRef()

Returns the PoolNameRef instance for this pool ref.

Returns:

PoolNameRef for this pool ref.

getProjectIdMask

public String getProjectIdMask()

Returns the glob style Project ID mask for this pool ref.

Returns:

Glob style Project ID mask.

getBottomLevelMask

public String getBottomLevelMask()

Returns the glob style Bottom Location Level Mask for this pool ref.

Returns:

Glob style Bottom Location Level Mask

getTopLevelMask

public String getTopLevelMask()

Returns the glob style Top Location Level Mask for this pool ref.

Returns:

Glob style Top Location Level Mask

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object