org.osid.control

Interface SceneQuery

All Superinterfaces:

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

public interface SceneQuery
extends OsidObjectQuery

This is the query for searching scenes. Each method match 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	clearSettingIdTerms() Clears the setting Id query terms.
void	clearSettingTerms() Clears the setting query terms.
void	clearSystemIdTerms() Clears the system Id query terms.
void	clearSystemTerms() Clears the system query terms.
SceneQueryRecord	getSceneQueryRecord(Type sceneRecordType) Gets the query record corresponding to the given Scene record Type.
SettingQuery	getSettingQuery() Gets the query for a setting.
SystemQuery	getSystemQuery() Gets the query for a system.
void	matchAnySetting(boolean match) Matches scenes with any setting.
void	matchSettingId(Id settingId, boolean match) Sets the setting Id for this query.
void	matchSystemId(Id systemId, boolean match) Sets the system Id for this query to match scenes assigned to systems.
boolean	supportsSettingQuery() Tests if a SettingQuery is available.
boolean	supportsSystemQuery() Tests if a SystemQuery is available.

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

Method Detail

matchSettingId

void matchSettingId(Id settingId,
                  boolean match)

Sets the setting Id for this query.

Parameters:

settingId - the setting Id

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

Throws:

NullArgumentException - settingId is null

Compliance:

mandatory - This method must be implemented.

clearSettingIdTerms

void clearSettingIdTerms()

Clears the setting Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsSettingQuery

boolean supportsSettingQuery()

Tests if a SettingQuery is available.

Returns:

true if a setting query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSettingQuery

SettingQuery getSettingQuery()

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

Returns:

the setting query

Throws:

UnimplementedException - supportsSettingQuery() is false

Compliance:

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

matchAnySetting

void matchAnySetting(boolean match)

Matches scenes with any setting.

Parameters:

match - true to match scenes with any setting, false to match scenes with no settings

Compliance:

mandatory - This method must be implemented.

clearSettingTerms

void clearSettingTerms()

Clears the setting query terms.

Compliance:

mandatory - This method must be implemented.

matchSystemId

void matchSystemId(Id systemId,
                 boolean match)

Sets the system Id for this query to match scenes assigned to systems.

Parameters:

systemId - the scene Id

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

Throws:

NullArgumentException - sceneId is null

Compliance:

mandatory - This method must be implemented.

clearSystemIdTerms

void clearSystemIdTerms()

Clears the system Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsSystemQuery

boolean supportsSystemQuery()

Tests if a SystemQuery is available.

Returns:

true if a system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSystemQuery

SystemQuery getSystemQuery()

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

Returns:

the system query

Throws:

UnimplementedException - supportsSystemQuery() is false

Compliance:

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

clearSystemTerms

void clearSystemTerms()

Clears the system query terms.

Compliance:

mandatory - This method must be implemented.

getSceneQueryRecord

SceneQueryRecord getSceneQueryRecord(Type sceneRecordType)
                                     throws OperationFailedException

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

Parameters:

sceneRecordType - a scene record type

Returns:

the scene query record

Throws:

NullArgumentException - sceneRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(sceneRecordType) is false

Compliance:

mandatory - This method must be implemented.