Package hec.data.pool
Interface IPool
- All Known Implementing Classes:
Pool
public interface IPool
Pool object that represents the pool information retrieved from the database as HecJavaDev objects.
-
Method Summary
Modifier and TypeMethodDescriptionasRef()
Creates a new PoolRef that contains all information associated with this pool.Returns the bottom location level as a ref object.Returns the pool name information for this pool.Returns the Project location as a LocationTemplate.Returns the top location level as a ref object.boolean
Determines if the pool is implicitly created by the database API's.
-
Method Details
-
getPoolName
IPoolName getPoolName()Returns the pool name information for this pool.- Returns:
- Pool name information
-
getProjectLocationTemplate
LocationTemplate getProjectLocationTemplate()Returns the Project location as a LocationTemplate. This uses the same office as the IPoolName.- Returns:
- Project location object
-
getBottomLocationLevel
ILocationLevelRef getBottomLocationLevel()Returns the bottom location level as a ref object.- Returns:
- Bottom location level object
-
getTopLocationLevel
ILocationLevelRef getTopLocationLevel()Returns the top location level as a ref object.- Returns:
- Top location level object.
-
asRef
PoolRef asRef()Creates a new PoolRef that contains all information associated with this pool.- Returns:
- New pool ref instance representing this object.
-
isImplicit
boolean isImplicit()Determines if the pool is implicitly created by the database API's.- Returns:
- True when the pool is implicitly created by the database.
-