OSID - osid.repository.RepositoryQuery Service Interface Definition

Interface	osid.repository.RepositoryQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching repositories. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchAssetId
Description	Sets the asset `Id` for this query.
Parameters	`osid.id.Id`	`assetId`	an asset `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assetId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssetIdTerms
Description	Clears the asset `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetQuery
Description	Tests if an `AssetQuery` is available.
Return	`boolean`		`true` if an asset query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssetQuery
Description	Gets the query for an asset. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.AssetQuery`		the asset query
Errors	UNIMPLEMENTED		`supportsAssetQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssetQuery()` is `true.`
Method	matchAnyAsset
Description	Matches repositories that has any asset mapping.
Parameters	`boolean`	`match`	`true` to match repositories with any asset, `false` to match repositories with no asset
Compliance	`mandatory`		This method must be implemented.
Method	clearAssetTerms
Description	Clears the asset terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCompositionId
Description	Sets the composition `Id` for this query.
Parameters	`osid.id.Id`	`compositionId`	a composition `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`compositionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCompositionIdTerms
Description	Clears the composition `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompositionQuery
Description	Tests if a `CompositionQuery` is available.
Return	`boolean`		`true` if a composition query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionQuery
Description	Gets the query for a composition. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.CompositionQuery`		the composition query
Errors	UNIMPLEMENTED		`supportsCompositionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompositionQuery()` is `true.`
Method	matchAnyComposition
Description	Matches repositories that has any composition mapping.
Parameters	`boolean`	`match`	`true` to match repositories with any composition, `false` to match repositories with no composition
Compliance	`mandatory`		This method must be implemented.
Method	clearCompositionTerms
Description	Clears the composition terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorRepositoryId
Description	Sets the repository `Id` for this query to match repositories that have the specified repository as an ancestor.
Parameters	`osid.id.Id`	`repositoryId`	a repository `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`repositoryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorRepositoryIdTerms
Description	Clears the ancestor repository `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorRepositoryQuery
Description	Tests if a `RepositoryQuery` is available.
Return	`boolean`		`true` if a repository query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorRepositoryQuery
Description	Gets the query for a repository. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.RepositoryQuery`		the repository query
Errors	UNIMPLEMENTED		`supportsAncestorRepositoryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorRepositoryQuery()` is `true.`
Method	matchAnyAncestorRepository
Description	Matches repositories with any ancestor.
Parameters	`boolean`	`match`	`true` to match repositories with any ancestor, `false` to match root repositories
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorRepositoryTerms
Description	Clears the ancestor repository terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantRepositoryId
Description	Sets the repository `Id` for this query to match repositories that have the specified repository as a descendant.
Parameters	`osid.id.Id`	`repositoryId`	a repository `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`repositoryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantRepositoryIdTerms
Description	Clears the descendant repository `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantRepositoryQuery
Description	Tests if a `RepositoryQuery` is available.
Return	`boolean`		`true` if a repository query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantRepositoryQuery
Description	Gets the query for a repository. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.RepositoryQuery`		the repository query
Errors	UNIMPLEMENTED		`supportsDescendantRepositoryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantRepositoryQuery()` is `true.`
Method	matchAnyDescendantRepository
Description	Matches repositories with any descendant.
Parameters	`boolean`	`match`	`true` to match repositories with any descendant, `false` to match leaf repositories
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantRepositoryTerms
Description	Clears the descendant repository terms.
Compliance	`mandatory`		This method must be implemented.
Method	getRepositoryQueryRecord
Description	Gets the repository query record corresponding to the given `Repository` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`repositoryRecordType`	a repository record type
Return	`osid.repository.records.RepositoryQueryRecord`		the repository query record
Errors	NULL_ARGUMENT		`repositoryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(repositoryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.