Package hec.data.pool

Class Pool

java.lang.Object

hec.data.pool.Pool

All Implemented Interfaces:

IPool

public class Pool
extends Object
implements IPool

Pool object that represents the pool information retrieved from the database as HecJavaDev objects.

Constructor Summary

Constructors

Constructor	Description
Pool(IPoolName poolName, LocationTemplate projectLocation, ILocationLevelRef bottomLevel, ILocationLevelRef topLevel)	Constructs a new Pool given the PoolName information, Project LocationTemplate, and top and bottom ILocationLevelRef's
Pool(IPoolName poolName, LocationTemplate projectLocation, ILocationLevelRef bottomLevel, ILocationLevelRef topLevel, boolean implicit)

Method Summary

Modifier and Type	Method	Description
PoolRef	asRef()	Creates a new PoolRef that contains all information associated with this pool.
boolean	equals(Object obj)
ILocationLevelRef	getBottomLocationLevel()	Returns the bottom location level as a ref object.
IPoolName	getPoolName()	Returns the pool name information for this pool.
LocationTemplate	getProjectLocationTemplate()	Returns the Project location as a LocationTemplate.
ILocationLevelRef	getTopLocationLevel()	Returns the top location level as a ref object.
int	hashCode()
boolean	isImplicit()	Determines if the pool is implicitly created by the database API's.

Methods inherited from class java.lang.Object

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

Constructor Details

Pool

public Pool(IPoolName poolName,
 LocationTemplate projectLocation,
 ILocationLevelRef bottomLevel,
 ILocationLevelRef topLevel)

Constructs a new Pool given the PoolName information, Project LocationTemplate, and top and bottom ILocationLevelRef's

Parameters:

poolName - Pool name data

projectLocation - Project LocationTemplate instance

bottomLevel - Bottom location level reference

topLevel - Top location level reference

Pool

public Pool(IPoolName poolName,
 LocationTemplate projectLocation,
 ILocationLevelRef bottomLevel,
 ILocationLevelRef topLevel,
 boolean implicit)

Method Details

getPoolName

public IPoolName getPoolName()

Description copied from interface: IPool

Returns the pool name information for this pool.

Specified by:

getPoolName in interface IPool

Returns:

Pool name information

getProjectLocationTemplate

public LocationTemplate getProjectLocationTemplate()

Description copied from interface: IPool

Returns the Project location as a LocationTemplate. This uses the same office as the IPoolName.

Specified by:

getProjectLocationTemplate in interface IPool

Returns:

Project location object

getBottomLocationLevel

public ILocationLevelRef getBottomLocationLevel()

Description copied from interface: IPool

Returns the bottom location level as a ref object.

Specified by:

getBottomLocationLevel in interface IPool

Returns:

Bottom location level object

getTopLocationLevel

public ILocationLevelRef getTopLocationLevel()

Description copied from interface: IPool

Returns the top location level as a ref object.

Specified by:

getTopLocationLevel in interface IPool

Returns:

Top location level object.

isImplicit

public boolean isImplicit()

Description copied from interface: IPool

Determines if the pool is implicitly created by the database API's.

Specified by:

isImplicit in interface IPool

Returns:

True when the pool is implicitly created by the database.

asRef

public PoolRef asRef()

Description copied from interface: IPool

Creates a new PoolRef that contains all information associated with this pool.

Specified by:

asRef in interface IPool

Returns:

New pool ref instance representing this object.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object