public interface Project extends OsidObject, Temporal
A Project
is the initial construction of the building or
a later construction, expansion, or renovation. The effective dates of the
project indicate when this project was active.
Modifier and Type | Method and Description |
---|---|
Building |
getBuilding()
Gets the building.
|
Id |
getBuildingId()
Gets the
Id of the building. |
Currency |
getCost()
Gets the cost for this renovation.
|
ProjectRecord |
getProjectRecord(Type projectRecordType)
Gets the project record corresponding to the given
Project
record Type. |
boolean |
hasCost()
Tests if this renovation has a cost.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getBuildingId()
Id
of the building. Id
mandatory
- This method must be implemented. Building getBuilding() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasCost()
true
if a cost is available, false
otherwisemandatory
- This method must be implemented. Currency getCost()
IllegalStateException
- hasCost()
is
false
mandatory
- This method must be implemented. ProjectRecord getProjectRecord(Type projectRecordType) throws OperationFailedException
Project
record Type.
This method is used to retrieve an
object implementing the requested record. The ProjectRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(projectRecordType)
is true
.projectRecordType
- the type of project record to retrieveNullArgumentException
- projectRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(projectRecordType)
is false
mandatory
- This method must be implemented.