info.magnolia.dam.api

Interface AssetQuery

public interface AssetQuery

Represents a query to an AssetProvider. Use new AssetQuery.Builder()...build() to construct instances.

See Also:

AssetProvider.list(AssetQuery)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AssetQuery.Builder A builder for AssetQuery which provides a fluent API.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAdditionalQueryStatement() Deprecated. since 2.0. Kept around for backwards compatibility.
String	getExtension()
String	getKeywordSearchTerm()
long	getMaxResults()
List<com.google.common.net.MediaType>	getMediaTypes()
Folder	getRootFolder()
String	getRootPath()
boolean	includesAssets()
boolean	includesChildren() Deprecated. since 2.0.5. use includesDescendants()
boolean	includesDescendants() Includes all the descendants of the specified path or folder, not just the direct children.
boolean	includesFolders()

Method Detail

getRootPath

String getRootPath()

getRootFolder

Folder getRootFolder()

includesChildren

boolean includesChildren()

Deprecated. since 2.0.5. use includesDescendants()

includesDescendants

boolean includesDescendants()

Includes all the descendants of the specified path or folder, not just the direct children.

getMediaTypes

List<com.google.common.net.MediaType> getMediaTypes()

getExtension

String getExtension()

getKeywordSearchTerm

String getKeywordSearchTerm()

getAdditionalQueryStatement

String getAdditionalQueryStatement()

Deprecated. since 2.0. Kept around for backwards compatibility.

An additional statement, usually provider-specific, which is appended to the underlying query. There is no common language between providers, so there is no guarantee that this works accross providers. No guarantee is made by providers on how this is used either. Some providers might refuse to use this in addition to other criteria.

includesFolders

boolean includesFolders()

includesAssets

boolean includesAssets()

getMaxResults

long getMaxResults()