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

Modifier and Type	Method	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 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 OsidExtensibleQueryInspector

getRecordTypeTerms

Modifier and Type	Method	Description
TypeTerm[]	getRecordTypeTerms()	Gets the record type query terms.

Methods inherited from interface OsidIdentifiableQueryInspector

getIdTerms

Modifier and Type	Method	Description
IdTerm[]	getIdTerms()	Gets the Id query terms.

Methods inherited from interface OsidObjectQueryInspector

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

Modifier and Type	Method	Description
IdTerm[]	getCommentIdTerms()	Gets the comment Id query terms.
CommentQueryInspector[]	getCommentTerms()	Gets the comment query terms.
IdTerm[]	getCreditIdTerms()	Gets the credit Id query terms.
CreditQueryInspector[]	getCreditTerms()	Gets the credit query terms.
StringTerm[]	getDescriptionTerms()	Gets the description query terms.
StringTerm[]	getDisplayNameTerms()	Gets the display name query terms.
TypeTerm[]	getGenusTypeTerms()	Gets the genus type query terms.
IdTerm[]	getJournalEntryIdTerms()	Gets the journal entry Id query terms.
JournalEntryQueryInspector[]	getJournalEntryTerms()	Gets the journal entry query terms.
TypeTerm[]	getParentGenusTypeTerms()	Gets the parent genus type query terms.
IdTerm[]	getRelationshipIdTerms()	Gets the relationship Id query terms.
IdTerm[]	getRelationshipPeerIdTerms()	Gets the relationship peer Id query terms.
RelationshipQueryInspector[]	getRelationshipTerms()	Gets the relationship query terms.
IdTerm[]	getStateIdTerms()	Gets the state Id query terms.
StateQueryInspector[]	getStateTerms()	Gets the state query terms.
StatisticQueryInspector[]	getStatisticTerms()	Gets the statistic query terms.
IdTerm[]	getSubjectIdTerms()	Gets the subject Id query terms.
RelevancyQueryInspector[]	getSubjectRelevancyTerms()	Gets the subject relevancy query terms.
SubjectQueryInspector[]	getSubjectTerms()	Gets the subject query terms.

Methods inherited from interface OsidQueryInspector

getAnyTerms, getKeywordTerms

Modifier and Type	Method	Description
BooleanTerm[]	getAnyTerms()	Gets the any query terms.
StringTerm[]	getKeywordTerms()	Gets the keyword query terms.

Methods inherited from interface OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

Modifier and Type	Method	Description
IdTerm[]	getEndReasonIdTerms()	Gets the end reaosn state Id query terms.
StateQueryInspector[]	getEndReasonTerms()	Gets the end reaosn state query terms.

Methods inherited from interface OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Modifier and Type	Method	Description
DateTimeRangeTerm[]	getDateTerms()	Gets the date query terms.
BooleanTerm[]	getEffectiveTerms()	Gets the effective query terms.
DateTimeRangeTerm[]	getEndDateTerms()	Gets the end date query terms.
DateTimeRangeTerm[]	getStartDateTerms()	Gets the start date query terms.

Method Details

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.