com.fatwire.assetapi.data

Interface ContentQueryManager

All Known Implementing Classes:

ContentQueryManagerImpl

@Exported
public interface ContentQueryManager

Method Summary

Modifier and Type	Method and Description
List<AssetResultRow>	execute(long contentQueryId, String siteName) Given the id of Content Query, this fetches the list of assets matching Content Query's search criteria.
List<AssetResultRow>	execute(long contentQueryId, String siteName, Integer listSize, String sortField, String sortOrder) Given the name of Content Query, this fetches the list of assets matching Content Query's search criteria.
List<AssetResultRow>	execute(String contentQueryName, String siteName) Given the name of Content Query, this fetches the list of assets matching Content Query's search criteria.
List<AssetResultRow>	execute(String contentQueryName, String siteName, Integer listSize, String sortField, String sortOrder) Given the name of Content Query, this fetches the list of assets matching Content Query's search criteria.

Method Detail

execute

List<AssetResultRow> execute(String contentQueryName,
                             String siteName)
                      throws AssetAccessException

Given the name of Content Query, this fetches the list of assets matching Content Query's search criteria.

Parameters:

contentQueryName - Content Query asset name.

siteName - Name of the site/publication

Returns:

List of assets which obey the search criteria of the given Content Query asset.

Throws:

AssetAccessException - if there is no Content Query asset by the given name OR there are issues reading the asset information.

execute

List<AssetResultRow> execute(String contentQueryName,
                             String siteName,
                             Integer listSize,
                             String sortField,
                             String sortOrder)
                      throws AssetAccessException

Given the name of Content Query, this fetches the list of assets matching Content Query's search criteria.

Parameters:

contentQueryName - Content Query asset name.

siteName - Name of the site/publication

listSize - The maximum size of the list which you want from Content Query. If no value is provided then it will pick "List Size" of Content Query asset.

sortField - The field on which the list of assets will be sorted. If no value is provided then it will pick the "Sort Field" value of Content Query asset.

sortOrder - The order in which the list of assets will be sorted. The default sort order is "ascending".

Returns:

List of assets as per the size give size and sort parameters.

Throws:

AssetAccessException - if there is no Content Query asset by the given name OR there are issues reading the asset information.

execute

List<AssetResultRow> execute(long contentQueryId,
                             String siteName)
                      throws AssetAccessException

Given the id of Content Query, this fetches the list of assets matching Content Query's search criteria.

Parameters:

contentQueryId - Content Query asset's id.

siteName - Name of the site/publication

Returns:

List of assets which obey the search criteria of the given Content Query asset.

Throws:

AssetAccessException - if there are issues reading the asset information.

execute

List<AssetResultRow> execute(long contentQueryId,
                             String siteName,
                             Integer listSize,
                             String sortField,
                             String sortOrder)
                      throws AssetAccessException

Given the name of Content Query, this fetches the list of assets matching Content Query's search criteria.

Parameters:

contentQueryId - Content Query asset's id.

siteName - Name of the site/publication

listSize - The maximum size of the list which you want from Content Query. If no value is provided then it will pick "List Size" of Content Query asset.

sortField - The field on which the list of assets will be sorted. If no value is provided then it will pick the "Sort Field" value of Content Query asset.

sortOrder - The order in which the list of assets will be sorted. The default sort order is "ascending".

Returns:

List of assets as per the size give size and sort parameters.

Throws:

AssetAccessException - if there are issues reading the asset information.