Queries¶

Asset Query¶

class dlkit.repository.queries.AssetQuery¶

Bases: dlkit.osid.queries.OsidObjectQuery, dlkit.osid.queries.OsidAggregateableQuery, dlkit.osid.queries.OsidSourceableQuery

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.

match_title(title, string_match_type, match)¶

Adds a title for this query.

Parameters:	title (`string`) – title string to match string_match_type (`osid.type.Type`) – the string match type match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`InvalidArgument` – `title` not of `string_match_type`
Raise:	`NullArgument` – `title` or `string_match_type` is `null`
Raise:	`Unsupported` – `supports_string_match_type(string_match_type)` is `false`

match_any_title(match)¶

Matches a title that has any value.

Parameters:	match (`boolean`) – `true` to match assets with any title, `false` to match assets with no title

title_terms¶

match_public_domain(public_domain)¶

Matches assets marked as public domain.

Parameters:	public_domain (`boolean`) – public domain flag

match_any_public_domain(match)¶

Matches assets with any public domain value.

Parameters:	match (`boolean`) – `true` to match assets with any public domain value, `false` to match assets with no public domain value

public_domain_terms¶

match_copyright(copyright_, string_match_type, match)¶

Adds a copyright for this query.

Parameters:	copyright (`string`) – copyright string to match string_match_type (`osid.type.Type`) – the string match type match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`InvalidArgument` – `copyright` not of `string_match_type`
Raise:	`NullArgument` – `copyright` or `string_match_type` is `null`
Raise:	`Unsupported` – `supports_string_match_type(string_match_type)` is `false`

match_any_copyright(match)¶

Matches assets with any copyright statement.

Parameters:	match (`boolean`) – `true` to match assets with any copyright value, `false` to match assets with no copyright value

copyright_terms¶

match_copyright_registration(registration, string_match_type, match)¶

Adds a copyright registration for this query.

Parameters:	registration (`string`) – copyright registration string to match string_match_type (`osid.type.Type`) – the string match type match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`InvalidArgument` – `registration` not of `string_match_type`
Raise:	`NullArgument` – `registration` or `string_match_type` is `null`
Raise:	`Unsupported` – `supports_string_match_type(string_match_type)` is `false`

match_any_copyright_registration(match)¶

Matches assets with any copyright registration.

Parameters:	match (`boolean`) – `true` to match assets with any copyright registration value, `false` to match assets with no copyright registration value

copyright_registration_terms¶

match_distribute_verbatim(distributable)¶

Matches assets marked as distributable.

Parameters:	distributable (`boolean`) – distribute verbatim rights flag

distribute_verbatim_terms¶

match_distribute_alterations(alterable)¶

Matches assets that whose alterations can be distributed.

Parameters:	alterable (`boolean`) – distribute alterations rights flag

distribute_alterations_terms¶

match_distribute_compositions(composable)¶

Matches assets that can be distributed as part of other compositions.

Parameters:	composable (`boolean`) – distribute compositions rights flag

distribute_compositions_terms¶

match_source_id(source_id, match)¶

Sets the source Id for this query.

Parameters:	source_id (`osid.id.Id`) – the source `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `source_id` is `null`

source_id_terms¶

supports_source_query()¶

Tests if a ResourceQuery is available for the source.

Returns:	`true` if a resource query is available, `false` otherwise
Return type:	`boolean`

source_query¶

Gets the query for the source.

Multiple queries can be retrieved for a nested OR term.

Returns:	the source query
Return type:	`osid.resource.ResourceQuery`
Raise:	`Unimplemented` – `supports_source_query()` is `false`

match_any_source(match)¶

Matches assets with any source.

Parameters:	match (`boolean`) – `true` to match assets with any source, `false` to match assets with no sources

source_terms¶

match_created_date(start, end, match)¶

Match assets that are created between the specified time period.

Parameters:	start (`osid.calendaring.DateTime`) – start time of the query end (`osid.calendaring.DateTime`) – end time of the query match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`InvalidArgument` – `end` is les than `start`
Raise:	`NullArgument` – `start` or `end` is `null`

match_any_created_date(match)¶

Matches assets with any creation time.

Parameters:	match (`boolean`) – `true` to match assets with any created time, `false` to match assets with no cerated time

created_date_terms¶

match_published(published)¶

Marks assets that are marked as published.

Parameters:	published (`boolean`) – published flag

published_terms¶

match_published_date(start, end, match)¶

Match assets that are published between the specified time period.

Parameters:	start (`osid.calendaring.DateTime`) – start time of the query end (`osid.calendaring.DateTime`) – end time of the query match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`InvalidArgument` – `end` is les than `start`
Raise:	`NullArgument` – `start` or `end` is `null`

match_any_published_date(match)¶

Matches assets with any published time.

Parameters:	match (`boolean`) – `true` to match assets with any published time, `false` to match assets with no published time

published_date_terms¶

match_principal_credit_string(credit, string_match_type, match)¶

Adds a principal credit string for this query.

Parameters:	credit (`string`) – credit string to match string_match_type (`osid.type.Type`) – the string match type match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`InvalidArgument` – `credit` not of `string_match_type`
Raise:	`NullArgument` – `credit` or `string_match_type` is `null`
Raise:	`Unsupported` – `supports_string_match_type(string_match_type)` is `false`

match_any_principal_credit_string(match)¶

Matches a principal credit string that has any value.

Parameters:	match (`boolean`) – `true` to match assets with any principal credit string, `false` to match assets with no principal credit string

principal_credit_string_terms¶

match_temporal_coverage(start, end, match)¶

Match assets that whose coverage falls between the specified time period inclusive.

Parameters:	start (`osid.calendaring.DateTime`) – start time of the query end (`osid.calendaring.DateTime`) – end time of the query match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`InvalidArgument` – `end` is less than `start`
Raise:	`NullArgument` – `start` or `end` is `null`

match_any_temporal_coverage(match)¶

Matches assets with any temporal coverage.

Parameters:	match (`boolean`) – `true` to match assets with any temporal coverage, `false` to match assets with no temporal coverage

temporal_coverage_terms¶

match_location_id(location_id, match)¶

Sets the location Id for this query of spatial coverage.

Parameters:	location_id (`osid.id.Id`) – the location `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `location_id` is `null`

location_id_terms¶

supports_location_query()¶

Tests if a LocationQuery is available for the provider.

Returns:	`true` if a location query is available, `false` otherwise
Return type:	`boolean`

location_query¶

Gets the query for a location.

Multiple queries can be retrieved for a nested OR term.

Returns:	the location query
Return type:	`osid.mapping.LocationQuery`
Raise:	`Unimplemented` – `supports_location_query()` is `false`

match_any_location(match)¶

Matches assets with any provider.

Parameters:	match (`boolean`) – `true` to match assets with any location, `false` to match assets with no locations

location_terms¶

match_spatial_coverage(spatial_unit, match)¶

Matches assets that are contained within the given spatial unit.

Parameters:	spatial_unit (`osid.mapping.SpatialUnit`) – the spatial unit match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `spatial_unit` is `null`
Raise:	`Unsupported` – `spatial_unit` is not suppoted

spatial_coverage_terms¶

match_spatial_coverage_overlap(spatial_unit, match)¶

Matches assets that overlap or touch the given spatial unit.

Parameters:	spatial_unit (`osid.mapping.SpatialUnit`) – the spatial unit match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `spatial_unit` is `null`
Raise:	`Unsupported` – `spatial_unit` is not suppoted

match_any_spatial_coverage(match)¶

Matches assets with no spatial coverage.

Parameters:	match (`boolean`) – `true` to match assets with any spatial coverage, `false` to match assets with no spatial coverage

spatial_coverage_overlap_terms¶

match_asset_content_id(asset_content_id, match)¶

Sets the asset content Id for this query.

Parameters:	asset_content_id (`osid.id.Id`) – the asset content `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `asset_content_id` is `null`

asset_content_id_terms¶

supports_asset_content_query()¶

Tests if an AssetContentQuery is available.

Returns:	`true` if an asset content query is available, `false` otherwise
Return type:	`boolean`

asset_content_query¶

Gets the query for the asset content.

Multiple queries can be retrieved for a nested OR term.

Returns:	the asset contents query
Return type:	`osid.repository.AssetContentQuery`
Raise:	`Unimplemented` – `supports_asset_content_query()` is `false`

match_any_asset_content(match)¶

Matches assets with any content.

Parameters:	match (`boolean`) – `true` to match assets with any content, `false` to match assets with no content

asset_content_terms¶

match_composition_id(composition_id, match)¶

Sets the composition Id for this query to match assets that are a part of the composition.

Parameters:	composition_id (`osid.id.Id`) – the composition `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `composition_id` is `null`

composition_id_terms¶

supports_composition_query()¶

Tests if a CompositionQuery is available.

Returns:	`true` if a composition query is available, `false` otherwise
Return type:	`boolean`

composition_query¶

Gets the query for a composition.

Multiple queries can be retrieved for a nested OR term.

Returns:	the composition query
Return type:	`osid.repository.CompositionQuery`
Raise:	`Unimplemented` – `supports_composition_query()` is `false`

match_any_composition(match)¶

Matches assets with any composition mappings.

Parameters:	match (`boolean`) – `true` to match assets with any composition, `false` to match assets with no composition mappings

composition_terms¶

match_repository_id(repository_id, match)¶

Sets the repository Id for this query.

Parameters:	repository_id (`osid.id.Id`) – the repository `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `repository_id` is `null`

repository_id_terms¶

supports_repository_query()¶

Tests if a RepositoryQuery is available.

Returns:	`true` if a repository query is available, `false` otherwise
Return type:	`boolean`

repository_query¶

Gets the query for a repository.

Multiple queries can be retrieved for a nested OR term.

Returns:	the repository query
Return type:	`osid.repository.RepositoryQuery`
Raise:	`Unimplemented` – `supports_repository_query()` is `false`

repository_terms¶

get_asset_query_record(asset_record_type)¶

Gets the asset query record corresponding to the given Asset record Type.

Multiuple retrievals produce a nested OR term.

Parameters:	asset_record_type (`osid.type.Type`) – an asset record type
Returns:	the asset query record
Return type:	`osid.repository.records.AssetQueryRecord`
Raise:	`NullArgument` – `asset_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(asset_record_type)` is `false`

Asset Content Query¶

class dlkit.repository.queries.AssetContentQuery¶

Bases: dlkit.osid.queries.OsidObjectQuery, dlkit.osid.queries.OsidSubjugateableQuery

This is the query for searching asset contents.

Each method forms an AND term while multiple invocations of the same method produce a nested OR.

match_accessibility_type(accessibility_type, match)¶

Sets the accessibility types for this query.

Supplying multiple types behaves like a boolean OR among the elements.

Parameters:	accessibility_type (`osid.type.Type`) – an accessibilityType match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `accessibility_type` is `null`

match_any_accessibility_type(match)¶

Matches asset content that has any accessibility type.

Parameters:	match (`boolean`) – `true` to match content with any accessibility type, `false` to match content with no accessibility type

accessibility_type_terms¶

match_data_length(low, high, match)¶

Matches content whose length of the data in bytes are inclusive of the given range.

Parameters:	low (`cardinal`) – low range high (`cardinal`) – high range match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`InvalidArgument` – `low` is greater than `high`

match_any_data_length(match)¶

Matches content that has any data length.

Parameters:	match (`boolean`) – `true` to match content with any data length, `false` to match content with no data length

data_length_terms¶

match_data(data, match, partial)¶

Matches data in this content.

Parameters:	data (`byte[]`) – list of matching strings match (`boolean`) – `true` for a positive match, `false` for a negative match partial (`boolean`) – `true` for a partial match, `false` for a complete match
Raise:	`NullArgument` – `data` is `null`

match_any_data(match)¶

Matches content that has any data.

Parameters:	match (`boolean`) – `true` to match content with any data, `false` to match content with no data

data_terms¶

match_url(url, string_match_type, match)¶

Sets the url for this query.

Supplying multiple strings behaves like a boolean OR among the elements each which must correspond to the stringMatchType.

Parameters:	url (`string`) – url string to match string_match_type (`osid.type.Type`) – the string match type match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`InvalidArgument` – `url` not of `string_match_type`
Raise:	`NullArgument` – `url` or `string_match_type` is `null`
Raise:	`Unsupported` – `supports_string_match_type(url)` is `false`

match_any_url(match)¶

Matches content that has any url.

Parameters:	match (`boolean`) – `true` to match content with any url, `false` to match content with no url

url_terms¶

get_asset_content_query_record(asset_content_record_type)¶

Gets the asset content query record corresponding to the given AssetContent record Type.

Multiple record retrievals produce a nested OR term.

Parameters:	asset_content_record_type (`osid.type.Type`) – an asset content record type
Returns:	the asset content query record
Return type:	`osid.repository.records.AssetContentQueryRecord`
Raise:	`NullArgument` – `asset_content_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(asset_content_record_type)` is `false`

Repository Query¶

class dlkit.repository.queries.RepositoryQuery¶

Bases: dlkit.osid.queries.OsidCatalogQuery

This is the query for searching repositories.

Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

match_asset_id(asset_id, match)¶

Sets the asset Id for this query.

Parameters:	asset_id (`osid.id.Id`) – an asset `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `asset_id` is `null`

asset_id_terms¶

supports_asset_query()¶

Tests if an AssetQuery is available.

Returns:	`true` if an asset query is available, `false` otherwise
Return type:	`boolean`

asset_query¶

Gets the query for an asset.

Multiple retrievals produce a nested OR term.

Returns:	the asset query
Return type:	`osid.repository.AssetQuery`
Raise:	`Unimplemented` – `supports_asset_query()` is `false`

match_any_asset(match)¶

Matches repositories that has any asset mapping.

Parameters:	match (`boolean`) – `true` to match repositories with any asset, `false` to match repositories with no asset

asset_terms¶

match_composition_id(composition_id, match)¶

Sets the composition Id for this query.

Parameters:	composition_id (`osid.id.Id`) – a composition `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `composition_id` is `null`

composition_id_terms¶

supports_composition_query()¶

Tests if a CompositionQuery is available.

Returns:	`true` if a composition query is available, `false` otherwise
Return type:	`boolean`

composition_query¶

Gets the query for a composition.

Multiple retrievals produce a nested OR term.

Returns:	the composition query
Return type:	`osid.repository.CompositionQuery`
Raise:	`Unimplemented` – `supports_composition_query()` is `false`

match_any_composition(match)¶

Matches repositories that has any composition mapping.

Parameters:	match (`boolean`) – `true` to match repositories with any composition, `false` to match repositories with no composition

composition_terms¶

match_ancestor_repository_id(repository_id, match)¶

Sets the repository Id for this query to match repositories that have the specified repository as an ancestor.

Parameters:	repository_id (`osid.id.Id`) – a repository `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `repository_id` is `null`

ancestor_repository_id_terms¶

supports_ancestor_repository_query()¶

Tests if a RepositoryQuery is available.

Returns:	`true` if a repository query is available, `false` otherwise
Return type:	`boolean`

ancestor_repository_query¶

Gets the query for a repository.

Multiple retrievals produce a nested OR term.

Returns:	the repository query
Return type:	`osid.repository.RepositoryQuery`
Raise:	`Unimplemented` – `supports_ancestor_repository_query()` is `false`

match_any_ancestor_repository(match)¶

Matches repositories with any ancestor.

Parameters:	match (`boolean`) – `true` to match repositories with any ancestor, `false` to match root repositories

ancestor_repository_terms¶

match_descendant_repository_id(repository_id, match)¶

Sets the repository Id for this query to match repositories that have the specified repository as a descendant.

Parameters:	repository_id (`osid.id.Id`) – a repository `Id` match (`boolean`) – `true` for a positive match, `false` for a negative match
Raise:	`NullArgument` – `repository_id` is `null`

descendant_repository_id_terms¶

supports_descendant_repository_query()¶

Tests if a RepositoryQuery is available.

Returns:	`true` if a repository query is available, `false` otherwise
Return type:	`boolean`

descendant_repository_query¶

Gets the query for a repository.

Multiple retrievals produce a nested OR term.

Returns:	the repository query
Return type:	`osid.repository.RepositoryQuery`
Raise:	`Unimplemented` – `supports_descendant_repository_query()` is `false`

match_any_descendant_repository(match)¶

Matches repositories with any descendant.

Parameters:	match (`boolean`) – `true` to match repositories with any descendant, `false` to match leaf repositories

descendant_repository_terms¶

get_repository_query_record(repository_record_type)¶

Gets the repository query record corresponding to the given Repository record Type.

Multiple record retrievals produce a nested OR term.

Parameters:	repository_record_type (`osid.type.Type`) – a repository record type
Returns:	the repository query record
Return type:	`osid.repository.records.RepositoryQueryRecord`
Raise:	`NullArgument` – `repository_record_type` is `null`
Raise:	`OperationFailed` – unable to complete request
Raise:	`Unsupported` – `has_record_type(repository_record_type)` is `false`