org.osid.room.squatting

Interface LeaseQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface LeaseQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining for lease queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCampusIdTerms() Gets the campus Id terms.
CampusQueryInspector[]	getCampusTerms() Gets the campus terms.
LeaseQueryInspectorRecord	getLeaseQueryInspectorRecord(Type leaseRecordType) Gets the lease query inspector record corresponding to the given Lease record Type.
IdTerm[]	getRoomIdTerms() Gets the room Id terms.
RoomQueryInspector[]	getRoomTerms() Gets the room terms.
IdTerm[]	getTenantIdTerms() Gets the tenant Id terms.
ResourceQueryInspector[]	getTenantTerms() Gets the tenant terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getRoomIdTerms

IdTerm[] getRoomIdTerms()

Gets the room Id terms.

Returns:

the room Id terms

Compliance:

mandatory - This method must be implemented.

getRoomTerms

RoomQueryInspector[] getRoomTerms()

Gets the room terms.

Returns:

the room terms

Compliance:

mandatory - This method must be implemented.

getTenantIdTerms

IdTerm[] getTenantIdTerms()

Gets the tenant Id terms.

Returns:

the tenant Id terms

Compliance:

mandatory - This method must be implemented.

getTenantTerms

ResourceQueryInspector[] getTenantTerms()

Gets the tenant terms.

Returns:

the tenant terms

Compliance:

mandatory - This method must be implemented.

getCampusIdTerms

IdTerm[] getCampusIdTerms()

Gets the campus Id terms.

Returns:

the campus Id terms

Compliance:

mandatory - This method must be implemented.

getCampusTerms

CampusQueryInspector[] getCampusTerms()

Gets the campus terms.

Returns:

the campus terms

Compliance:

mandatory - This method must be implemented.

getLeaseQueryInspectorRecord

LeaseQueryInspectorRecord getLeaseQueryInspectorRecord(Type leaseRecordType)
                                                       throws OperationFailedException

Gets the lease query inspector record corresponding to the given Lease record Type.

Parameters:

leaseRecordType - a lease record type

Returns:

the lease query inspector record

Throws:

NullArgumentException - leaseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(leaseRecordType) is false

Compliance:

mandatory - This method must be implemented.