org.osid.room.squatting

Interface DeedQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

public interface DeedQuery
extends OsidRelationshipQuery

This is the query for searching for deeds. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearBuildingIdTerms() Clears the building Id terms.
void	clearBuildingTerms() Clears the building terms.
void	clearCampusIdTerms() Clears the campus Id terms.
void	clearCampusTerms() Clears the campus terms.
void	clearOwnerIdTerms() Clears the owner resource Id terms.
void	clearOwnerTerms() Clears the owner terms.
BuildingQuery	getBuildingQuery() Gets the query for a building query.
CampusQuery	getCampusQuery() Gets the query for a campus query.
DeedQueryRecord	getDeedQueryRecord(Type deedRecordType) Gets the deed query record corresponding to the given Deed record Type.
ResourceQuery	getOwnerQuery() Gets the query for an owner resource query.
void	matchBuildingId(Id buildingId, boolean match) Sets a building Id.
void	matchCampusId(Id campusId, boolean match) Sets the deed Id for this query to match rooms assigned to campuses.
void	matchOwnerId(Id resourceId, boolean match) Sets a resource Id.
boolean	supportsBuildingQuery() Tests if a BuildingQuery is available.
boolean	supportsCampusQuery() Tests if a CampusQuery is available.
boolean	supportsOwnerQuery() Tests if a ResourceQuery is available.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchBuildingId

void matchBuildingId(Id buildingId,
                   boolean match)

Sets a building Id.

Parameters:

buildingId - a building Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - buildingId is null

Compliance:

mandatory - This method must be implemented.

clearBuildingIdTerms

void clearBuildingIdTerms()

Clears the building Id terms.

Compliance:

mandatory - This method must be implemented.

supportsBuildingQuery

boolean supportsBuildingQuery()

Tests if a BuildingQuery is available.

Returns:

true if a building query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBuildingQuery

BuildingQuery getBuildingQuery()

Gets the query for a building query. Multiple retrievals produce a nested OR term.

Returns:

the building query

Throws:

UnimplementedException - supportsBuildingQuery() is false

Compliance:

optional - This method must be implemented if supportsBuildingQuery() is true.

clearBuildingTerms

void clearBuildingTerms()

Clears the building terms.

Compliance:

mandatory - This method must be implemented.

matchOwnerId

void matchOwnerId(Id resourceId,
                boolean match)

Sets a resource Id.

Parameters:

resourceId - a resource Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearOwnerIdTerms

void clearOwnerIdTerms()

Clears the owner resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsOwnerQuery

boolean supportsOwnerQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOwnerQuery

ResourceQuery getOwnerQuery()

Gets the query for an owner resource query. Multiple retrievals produce a nested OR term.

Returns:

the resource query

Throws:

UnimplementedException - supportsOwnerQuery() is false

Compliance:

optional - This method must be implemented if supportsOwnerQuery() is true.

clearOwnerTerms

void clearOwnerTerms()

Clears the owner terms.

Compliance:

mandatory - This method must be implemented.

matchCampusId

void matchCampusId(Id campusId,
                 boolean match)

Sets the deed Id for this query to match rooms assigned to campuses.

Parameters:

campusId - a campus Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - campusId is null

Compliance:

mandatory - This method must be implemented.

clearCampusIdTerms

void clearCampusIdTerms()

Clears the campus Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCampusQuery

boolean supportsCampusQuery()

Tests if a CampusQuery is available.

Returns:

true if a campus query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCampusQuery

CampusQuery getCampusQuery()

Gets the query for a campus query. Multiple retrievals produce a nested OR term.

Returns:

the campus query

Throws:

UnimplementedException - supportsCampusQuery() is false

Compliance:

optional - This method must be implemented if supportsCampusQuery() is true.

clearCampusTerms

void clearCampusTerms()

Clears the campus terms.

Compliance:

mandatory - This method must be implemented.

getDeedQueryRecord

DeedQueryRecord getDeedQueryRecord(Type deedRecordType)
                                   throws OperationFailedException

Gets the deed query record corresponding to the given Deed record Type. Multiple record retrievals produce a nested boolean OR term.

Parameters:

deedRecordType - a deed record type

Returns:

the deed query record

Throws:

NullArgumentException - deedRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(deedRecordType) is false

Compliance:

mandatory - This method must be implemented.