Package com.adobe.aem.formsndocuments.assets.models

Interface FMSearchCriteria.Builder

Enclosing interface:

FMSearchCriteria

@ProviderType
public static interface FMSearchCriteria.Builder

Method Summary

Modifier and Type	Method	Description
FMSearchCriteria	build()	Build search query and return as SearchCriteria
FMSearchCriteria.Builder	sortBy(FMSearchCriteria.Property property)	Use for specifying exactly one sorting property.
FMSearchCriteria.Builder	sortBy(FMSearchCriteria.Property property, FMSearchCriteria.SortCriteria criteria)	Use for specifying multiple sorting criteria.
FMSearchCriteria.Builder	sortBy(FMSearchCriteria.SortCriteria criteria)	Use for specifying exactly one sorting criteria.
FMSearchCriteria.Builder	withAssetType(FDAsset.AssetType assetType)	Set asset type(s) which should be searched.
FMSearchCriteria.Builder	withFullText(java.lang.String text)	FullText search on all metadata
FMSearchCriteria.Builder	withFullTextOn(java.lang.String text, FMSearchCriteria.Property property)	FullText search on given property
FMSearchCriteria.Builder	withLocation(java.lang.String path)	Set folder(s) to define search scope.
FMSearchCriteria.Builder	withMaxSize(int maxSize)	Set maximum size of the results to be returned by the search
FMSearchCriteria.Builder	withOffset(int offset)	Set offset for results.
FMSearchCriteria.Builder	withPropertyEquals(FMSearchCriteria.Property property, java.lang.String value)	Exact search on given property
FMSearchCriteria.Builder	withTag(java.lang.String tag)	Search for given tag.

Method Detail

build

FMSearchCriteria build()

Build search query and return as SearchCriteria

Returns:

sortBy

FMSearchCriteria.Builder sortBy(FMSearchCriteria.Property property)

Use for specifying exactly one sorting property. Multiple calls will modify existing criteria If sorting criteria not set, it's set to FMSearchCriteria.SortCriteria.ASC

Parameters:

property -

Returns:

sortBy

FMSearchCriteria.Builder sortBy(FMSearchCriteria.SortCriteria criteria)

Use for specifying exactly one sorting criteria. Multiple calls will modify existing criteria If the property to sort on is not set, it's set to FMSearchCriteria.Property.TITLE

Parameters:

criteria -

Returns:

sortBy

FMSearchCriteria.Builder sortBy(FMSearchCriteria.Property property,
                                FMSearchCriteria.SortCriteria criteria)

Use for specifying multiple sorting criteria. Successive calls will add on top of existing query.

Parameters:

property -

criteria -

Returns:

withAssetType

FMSearchCriteria.Builder withAssetType(FDAsset.AssetType assetType)

Set asset type(s) which should be searched. Multiple calls for multiple assets. Only supports assets under FDAsset.AssetType

Parameters:

assetType -

Returns:

withMaxSize

FMSearchCriteria.Builder withMaxSize(int maxSize)

Set maximum size of the results to be returned by the search

Parameters:

maxSize -

Returns:

withOffset

FMSearchCriteria.Builder withOffset(int offset)

Set offset for results.

Parameters:

offset -

Returns:

withLocation

FMSearchCriteria.Builder withLocation(java.lang.String path)

Set folder(s) to define search scope. Use multiple calls to add more paths.

Parameters:

path -

Returns:

withPropertyEquals

FMSearchCriteria.Builder withPropertyEquals(FMSearchCriteria.Property property,
                                            java.lang.String value)

Exact search on given property

Parameters:

property -

value -

Returns:

withFullTextOn

FMSearchCriteria.Builder withFullTextOn(java.lang.String text,
                                        FMSearchCriteria.Property property)

FullText search on given property

Parameters:

text -

property -

Returns:

withFullText

FMSearchCriteria.Builder withFullText(java.lang.String text)

FullText search on all metadata

Parameters:

text -

Returns:

withTag

FMSearchCriteria.Builder withTag(java.lang.String tag)

Search for given tag. Multiple calls to this interface adds tags in succession

Parameters:

tag -

Returns: