OSID - osid.repository.AssetQuery Service Interface Definition

Interface	osid.repository.AssetQuery
Implements	`osid.OsidObjectQuery`
	`osid.OsidAggregateableQuery`
	`osid.OsidSourceableQuery`
Description	This is the query for searching assets. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.` The query record is identified by the `Asset Type.`
Method	matchTitle
Description	Adds a title for this query.
Parameters	`string`	`title`	title string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`title` not of `stringMatchType`
	NULL_ARGUMENT		`title` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyTitle
Description	Matches a title that has any value.
Parameters	`boolean`	`match`	`true` to match assets with any title, `false` to match assets with no title
Compliance	`mandatory`		This method must be implemented.
Method	clearTitleTerms
Description	Clears the title terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPublicDomain
Description	Matches assets marked as public domain.
Parameters	`boolean`	`publicDomain`	public domain flag
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyPublicDomain
Description	Matches assets with any public domain value.
Parameters	`boolean`	`match`	`true` to match assets with any public domain value, `false` to match assets with no public domain value
Compliance	`mandatory`		This method must be implemented.
Method	clearPublicDomainTerms
Description	Clears the public domain terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCopyright
Description	Adds a copyright for this query.
Parameters	`string`	`copyright`	copyright string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`copyright` not of `stringMatchType`
	NULL_ARGUMENT		`copyright` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCopyright
Description	Matches assets with any copyright statement.
Parameters	`boolean`	`match`	`true` to match assets with any copyright value, `false` to match assets with no copyright value
Compliance	`mandatory`		This method must be implemented.
Method	clearCopyrightTerms
Description	Clears the copyright terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCopyrightRegistration
Description	Adds a copyright registration for this query.
Parameters	`string`	`registration`	copyright registration string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`registration` not of `stringMatchType`
	NULL_ARGUMENT		`registration` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCopyrightRegistration
Description	Matches assets with any copyright registration.
Parameters	`boolean`	`match`	`true` to match assets with any copyright registration value, `false` to match assets with no copyright registration value
Compliance	`mandatory`		This method must be implemented.
Method	clearCopyrightRegistrationTerms
Description	Clears the copyright registration terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistributeVerbatim
Description	Matches assets marked as distributable.
Parameters	`boolean`	`distributable`	distribute verbatim rights flag
Compliance	`mandatory`		This method must be implemented.
Method	clearDistributeVerbatimTerms
Description	Clears the distribute verbatim terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistributeAlterations
Description	Matches assets that whose alterations can be distributed.
Parameters	`boolean`	`alterable`	distribute alterations rights flag
Compliance	`mandatory`		This method must be implemented.
Method	clearDistributeAlterationsTerms
Description	Clears the distribute alterations terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistributeCompositions
Description	Matches assets that can be distributed as part of other compositions.
Parameters	`boolean`	`composable`	distribute compositions rights flag
Compliance	`mandatory`		This method must be implemented.
Method	clearDistributeCompositionsTerms
Description	Clears the distribute compositions terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSourceId
Description	Sets the source `Id` for this query.
Parameters	`osid.id.Id`	`sourceId`	the source `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`sourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSourceIdTerms
Description	Clears the source `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSourceQuery
Description	Tests if a `ResourceQuery` is available for the source.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSourceQuery
Description	Gets the query for the source. Multiple queries can be retrieved for a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the source query
Errors	UNIMPLEMENTED		`supportsSourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSourceQuery()` is `true.`
Method	matchAnySource
Description	Matches assets with any source.
Parameters	`boolean`	`match`	`true` to match assets with any source, `false` to match assets with no sources
Compliance	`mandatory`		This method must be implemented.
Method	clearSourceTerms
Description	Clears the source terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCreatedDate
Description	Match assets that are created between the specified time period.
Parameters	`osid.calendaring.DateTime`	`start`	start time of the query
	`osid.calendaring.DateTime`	`end`	end time of the query
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is les than `start`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCreatedDate
Description	Matches assets with any creation time.
Parameters	`boolean`	`match`	`true` to match assets with any created time, `false` to match assets with no cerated time
Compliance	`mandatory`		This method must be implemented.
Method	clearCreatedDateTerms
Description	Clears the created time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPublished
Description	Marks assets that are marked as published.
Parameters	`boolean`	`published`	published flag
Compliance	`mandatory`		This method must be implemented.
Method	clearPublishedTerms
Description	Clears the published terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPublishedDate
Description	Match assets that are published between the specified time period.
Parameters	`osid.calendaring.DateTime`	`start`	start time of the query
	`osid.calendaring.DateTime`	`end`	end time of the query
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is les than `start`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyPublishedDate
Description	Matches assets with any published time.
Parameters	`boolean`	`match`	`true` to match assets with any published time, `false` to match assets with no published time
Compliance	`mandatory`		This method must be implemented.
Method	clearPublishedDateTerms
Description	Clears the published time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPrincipalCreditString
Description	Adds a principal credit string for this query.
Parameters	`string`	`credit`	credit string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`credit` not of `stringMatchType`
	NULL_ARGUMENT		`credit` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyPrincipalCreditString
Description	Matches a principal credit string that has any value.
Parameters	`boolean`	`match`	`true` to match assets with any principal credit string, `false` to match assets with no principal credit string
Compliance	`mandatory`		This method must be implemented.
Method	clearPrincipalCreditStringTerms
Description	Clears the principal credit string terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTemporalCoverage
Description	Match assets that whose coverage falls between the specified time period inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start time of the query
	`osid.calendaring.DateTime`	`end`	end time of the query
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is less than `start`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyTemporalCoverage
Description	Matches assets with any temporal coverage.
Parameters	`boolean`	`match`	`true` to match assets with any temporal coverage, `false` to match assets with no temporal coverage
Compliance	`mandatory`		This method must be implemented.
Method	clearTemporalCoverageTerms
Description	Clears the temporal coverage terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLocationId
Description	Sets the location `Id` for this query of spatial coverage.
Parameters	`osid.id.Id`	`locationId`	the location `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`locationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationIdTerms
Description	Clears the location `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationQuery
Description	Tests if a `LocationQuery` is available for the provider.
Return	`boolean`		`true` if a location query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLocationQuery
Description	Gets the query for a location. Multiple queries can be retrieved for a nested `OR` term.
Return	`osid.mapping.LocationQuery`		the location query
Errors	UNIMPLEMENTED		`supportsLocationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationQuery()` is `true.`
Method	matchAnyLocation
Description	Matches assets with any provider.
Parameters	`boolean`	`match`	`true` to match assets with any location, `false` to match assets with no locations
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationTerms
Description	Clears the location terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSpatialCoverage
Description	Matches assets that are contained within the given spatial unit.
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	the spatial unit
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`spatialUnit` is `null`
Errors	UNSUPPORTED		`spatialUnit` is not suppoted
Compliance	`mandatory`		This method must be implemented.
Method	clearSpatialCoverageTerms
Description	Clears the spatial coverage terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSpatialCoverageOverlap
Description	Matches assets that overlap or touch the given spatial unit.
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	the spatial unit
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`spatialUnit` is `null`
Errors	UNSUPPORTED		`spatialUnit` is not suppoted
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySpatialCoverage
Description	Matches assets with no spatial coverage.
Parameters	`boolean`	`match`	`true` to match assets with any spatial coverage, `false` to match assets with no spatial coverage
Compliance	`mandatory`		This method must be implemented.
Method	clearSpatialCoverageOverlapTerms
Description	Clears the spatial coverage overlap terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAssetContentId
Description	Sets the asset content `Id` for this query.
Parameters	`osid.id.Id`	`assetContentId`	the asset content `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assetContentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssetContentIdTerms
Description	Clears the asset content `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetContentQuery
Description	Tests if an `AssetContentQuery` is available.
Return	`boolean`		`true` if an asset content query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssetContentQuery
Description	Gets the query for the asset content. Multiple queries can be retrieved for a nested `OR` term.
Return	`osid.repository.AssetContentQuery`		the asset contents query
Errors	UNIMPLEMENTED		`supportsAssetContentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssetContentQuery()` is `true.`
Method	matchAnyAssetContent
Description	Matches assets with any content.
Parameters	`boolean`	`match`	`true` to match assets with any content, `false` to match assets with no content
Compliance	`mandatory`		This method must be implemented.
Method	clearAssetContentTerms
Description	Clears the asset content terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCompositionId
Description	Sets the composition `Id` for this query to match assets that are a part of the composition.
Parameters	`osid.id.Id`	`compositionId`	the 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 queries can be retrieved for 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 assets with any composition mappings.
Parameters	`boolean`	`match`	`true` to match assets with any composition, `false` to match assets with no composition mappings
Compliance	`mandatory`		This method must be implemented.
Method	clearCompositionTerms
Description	Clears the composition terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRepositoryId
Description	Sets the repository `Id` for this query.
Parameters	`osid.id.Id`	`repositoryId`	the 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	clearRepositoryIdTerms
Description	Clears the repository `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRepositoryQuery
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	getRepositoryQuery
Description	Gets the query for a repository. Multiple queries can be retrieved for a nested `OR` term.
Return	`osid.repository.RepositoryQuery`		the repository query
Errors	UNIMPLEMENTED		`supportsRepositoryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRepositoryQuery()` is `true.`
Method	clearRepositoryTerms
Description	Clears the repository terms.
Compliance	`mandatory`		This method must be implemented.
Method	getAssetQueryRecord
Description	Gets the asset query record corresponding to the given `Asset` record `Type.` Multiuple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`assetRecordType`	an asset record type
Return	`osid.repository.records.AssetQueryRecord`		the asset query record
Errors	NULL_ARGUMENT		`assetRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(assetRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.