public interface ModelQuery extends OsidObjectQuery
This is the query for searching models. Each method match specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearArchetypeTerms()
Clears the archetype terms.
|
void |
clearManufacturerIdTerms()
Clears the manufacturer terms.
|
void |
clearManufacturerTerms()
Clears the manufacturer terms.
|
void |
clearNumberTerms()
Clears the model number terms.
|
void |
clearWarehouseIdTerms()
Clears the warehouse
Id query terms. |
void |
clearWarehouseTerms()
Clears the warehouse terms.
|
ResourceQuery |
getManufacturerQuery()
Gets the query for a manufacturer.
|
ModelQueryRecord |
getModelQueryRecord(Type modelRecordType)
Gets the model query record corresponding to the given
Model
record Type. |
WarehouseQuery |
getWarehouseQuery()
Gets the query for a warehouse.
|
void |
matchAnyArchetype(boolean match)
Matches items that have any archetype.
|
void |
matchAnyManufacturer(boolean match)
Matches any manufacturer.
|
void |
matchAnyNumber(boolean match)
Matches items that have any model number.
|
void |
matchArchetype(java.lang.String archetype,
Type stringMatchType,
boolean match)
Matches an archetype.
|
void |
matchManufacturerId(Id resourceId,
boolean match)
Sets the inventory
Id for this query to match models
that have a related manufacturer. |
void |
matchNumber(java.lang.String number,
Type stringMatchType,
boolean match)
Matches a model number.
|
void |
matchWarehouseId(Id warehouseId,
boolean match)
Sets the warehouse
Id for this query to match models
assigned to warehouses. |
boolean |
supportsManufacturerQuery()
Tests if a
ManufacturerQuery is available for the
location. |
boolean |
supportsWarehouseQuery()
Tests if a
WarehouseQuery is available. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchManufacturerId(Id resourceId, boolean match)
Id
for this query to match models
that have a related manufacturer.resourceId
- a resource Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearManufacturerIdTerms()
mandatory
- This method must be implemented. boolean supportsManufacturerQuery()
ManufacturerQuery
is available for the
location. true
if a manufacturer query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getManufacturerQuery()
OR
term.UnimplementedException
-
supportsManufacturerQuery()
is false
optional
- This method must be implemented if
supportsManufacturerQuery()
is true.
void matchAnyManufacturer(boolean match)
match
- true
to match models with any inventory,
false
to match models with no inventoriesmandatory
- This method must be implemented. void clearManufacturerTerms()
mandatory
- This method must be implemented. void matchArchetype(java.lang.String archetype, Type stringMatchType, boolean match)
archetype
- an archetype for the modelstringMatchType
- a string match typematch
- true
if a positive match, false
for a negative matchNullArgumentException
- archetype
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyArchetype(boolean match)
match
- true
to match items with any archetype,
false
to match items with no archetypemandatory
- This method must be implemented. void clearArchetypeTerms()
mandatory
- This method must be implemented. void matchNumber(java.lang.String number, Type stringMatchType, boolean match)
number
- a model numberstringMatchType
- a string match typematch
- true
if a positive match, false
for a negative matchNullArgumentException
- number
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyNumber(boolean match)
match
- true
to match items with any model
number, false
to match items with no model
numbermandatory
- This method must be implemented. void clearNumberTerms()
mandatory
- This method must be implemented. void matchWarehouseId(Id warehouseId, boolean match)
Id
for this query to match models
assigned to warehouses.warehouseId
- the warehouse Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- warehouseId
is
null
mandatory
- This method must be implemented. void clearWarehouseIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsWarehouseQuery()
WarehouseQuery
is available. true
if a warehouse query is available,
false
otherwisemandatory
- This method must be implemented. WarehouseQuery getWarehouseQuery()
OR
term.UnimplementedException
-
supportsWarehouseQuery()
is false
optional
- This method must be implemented if
supportsWarehouseQuery()
is true.
void clearWarehouseTerms()
mandatory
- This method must be implemented. ModelQueryRecord getModelQueryRecord(Type modelRecordType) throws OperationFailedException
Model
record Type.
Multiple record retrievals produce
a nested OR
term.modelRecordType
- a model record typeNullArgumentException
- modelRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(modelRecordType)
is false
mandatory
- This method must be implemented.