org.osid.room.squatting

Interface Deed

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface Deed
extends OsidRelationship

A Deed represents ownership of a building.

Method Summary

Methods

Modifier and Type	Method and Description
Building	getBuilding() Gets the owner building.
Id	getBuildingId() Gets the Id of the owner building.
DeedRecord	getDeedRecord(Type deedRecordType) Gets the deed record corresponding to the given Deed record Type.
Resource	getOwner() Gets the owner resource.
Id	getOwnerId() Gets the Id of the owner resource.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getBuildingId

Id getBuildingId()

Gets the Id of the owner building.

Returns:

the building Id

Compliance:

mandatory - This method must be implemented.

getBuilding

Building getBuilding()
                     throws OperationFailedException

Gets the owner building.

Returns:

the building

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getOwnerId

Id getOwnerId()

Gets the Id of the owner resource.

Returns:

the resource Id

Compliance:

mandatory - This method must be implemented.

getOwner

Resource getOwner()
                  throws OperationFailedException

Gets the owner resource.

Returns:

the resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getDeedRecord

DeedRecord getDeedRecord(Type deedRecordType)
                         throws OperationFailedException

Gets the deed record corresponding to the given Deed record Type. This method is used to retrieve an object implementing the requested record. The DeedRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(deedRecordType) is true .

Parameters:

deedRecordType - the type of deed record to retrieve

Returns:

the deed record

Throws:

NullArgumentException - deedRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(deedRecordType) is false

Compliance:

mandatory - This method must be implemented.