Interface Project

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, Temporal

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.

Method Summary

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.
boolean	hasCost()	Tests if this renovation has a cost.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Methods inherited from interface Temporal

getEndDate, getStartDate, isEffective

Modifier and Type	Method	Description
DateTime	getEndDate()	Gets the end date.
DateTime	getStartDate()	Gets the start date.
boolean	isEffective()	Tests if the current date is within the start end end dates inclusive.

Method Details

getBuildingId

Id getBuildingId()

Gets the Id of the building.

Returns:

the building Id

Compliance:

mandatory - This method must be implemented.

getBuilding

Building getBuilding()
              throws OperationFailedException

Gets the building.

Returns:

the building

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasCost

boolean hasCost()

Tests if this renovation has a cost.

Returns:

true if a cost is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCost

Currency getCost()

Gets the cost for this renovation.

Returns:

the cost

Throws:

IllegalStateException - hasCost() is false

Compliance:

mandatory - This method must be implemented.

getProjectRecord

ProjectRecord getProjectRecord(Type projectRecordType)
                        throws OperationFailedException

Gets the project record corresponding to the given 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 .

Parameters:

projectRecordType - the type of project record to retrieve

Returns:

the project record

Throws:

NullArgumentException - projectRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(projectRecordType) is false

Compliance:

mandatory - This method must be implemented.