com.fatwire.assetapi.data

Interface AssetFacade

All Known Implementing Classes:

AssetFacadeImpl

public interface AssetFacade

A helper class that provide basic asset access to Sites to remove users' dependencies on ICS and other Sites underlining managers *

Method Summary

Modifier and Type	Method and Description
List<AssetResultRow>	executeContentQuery(String siteName, Long assetId, String assetName, int limit, String sortingField, boolean ascending) Execute a ContentQuery to retrieve the results
AssetId	filterSingleAsset(AssetId asset, String desiredLocale, String dimensionSetName) Filter an asset based on a DimensionSet and a preferred locale
List<String>	getAllAssociations(AssetId id) Get a list of all defined associations for a given asset
List<String>	getAllAttributes(AssetId id) Get a list of all defined attributes back for given asset id
AssetId	getAssetByName(String site, String assetType, String assetName) Retrieve an asset id from an asset name; for the possible multiple returns (assets with same names), we will return the first asset from the list
String	getField(String assettype, String id, String fieldName) Get a field for a given asset type and id
String	getICSVar(String name) Get an ICS variable given name
List<AssetId>	getImmediateChildren(String siteName, AssetId assetId) Get the immediate children of a given flex parent asset
Long	getPublicationId(String assetName) Get the publication id given a publication name
List<RecommendedAssetId>	getRecommendations(String recommendationName, String alias, String profileName, Map<String,Object> profile, String segments, String sitename, boolean keepSegments) Get a list of recommended assets
AssetId	getRelative(AssetId asset, String locale) Get a relative of a given asset using the preferred locale
Collection<AssetId>	getRelatives(AssetId assetId) Retrieve the relatives of a given asset in a Collection
List<AssetId>	getSegments(String alias, String profileName, Map<String,Object> profile, String sitename) Get the segments that the visitor belongs to with visitor alias and visitor attributes
String	getSubtype(AssetId asset) Get the subtype for a given asset
boolean	isAssetInSite(AssetId asset, String site)
boolean	isAttributeExist(AssetData assetData, String attribute) Check if an Attribute exist in current assetData
boolean	isValid(AssetId id, Date date) Check an asset is valid or not for a given date
String	makeBlobLink(BlobLinkInfo linkInfo) Generate a blob link given table, identifierColumnName, identifier, and columnname with given BlobLinkInfo
String	makeLink(LinkInfo linkInfo) Generate a link given asset, template name and LinkInfo
String	processEmbeddedLink(InputStream data) Process the embeddedLink inside a binary attribute and return the processed result
String	processEmbeddedLink(String data) Process the embeddedLink inside a String/Text attribute and return the processed result
AssetData	read(AssetId assetId, List<String> attributes) Reads given set attribute data and returns an AssetData instance containing them.
Iterable<AssetData>	read(List<AssetId> assetIds, boolean immediateOnly) Read a list of AssetData given a list of AssetIds
List<AssetId>	retainSegments(String alias, String profileName, Map<String,Object> profile, String segments, String sitename) Get the segments from the specified list that the visitor belongs to with visitor alias and visitor attributes

Method Detail

read

Iterable<AssetData> read(List<AssetId> assetIds,
                         boolean immediateOnly)
                  throws AssetAccessException

Read a list of AssetData given a list of AssetIds

Parameters:

assetIds - the list of asset ids to read

Returns:

Iterable of asset data

Throws:

AssetAccessException - rethrown excetpion

read

AssetData read(AssetId assetId,
               List<String> attributes)
        throws AssetAccessException

Reads given set attribute data and returns an AssetData instance containing them.

Parameters:

assetId - AssetId to read attributes for

attributes - names of the attributes

Returns:

AssetData containing values for requested attributes.

Throws:

AssetAccessException - if thrown if the AssetId does not exist or attribute names passed are incorrect for the asset. AssetAccessException also wraps any AssetExcptions thrown by the internal implementation.

getAllAttributes

List<String> getAllAttributes(AssetId id)

Get a list of all defined attributes back for given asset id

Parameters:

id - the asset id to get attributes for

Returns:

the list of attributes names

getAllAssociations

List<String> getAllAssociations(AssetId id)

Get a list of all defined associations for a given asset

Parameters:

id - the asset id to get attributes for

Returns:

the list of association names

getICSVar

String getICSVar(String name)

Get an ICS variable given name

Parameters:

name - the name of the ICS variable

Returns:

the value for the ICS variable

getField

String getField(String assettype,
                String id,
                String fieldName)

Get a field for a given asset type and id

Parameters:

assettype - the asset type

id - the id of the asset

fieldName - the name of the field to get value for

Returns:

the value for the given field of the given asset

getSubtype

String getSubtype(AssetId asset)
           throws AssetAccessException

Get the subtype for a given asset

Parameters:

asset - the asset id

Returns:

the subtype name

Throws:

AssetAccessException - an AssetAccessException

isValid

boolean isValid(AssetId id,
                Date date)

Check an asset is valid or not for a given date

Parameters:

id - the asset id

date - the date of interest

Returns:

true if the asset is valid in the given date, false otherwise

getRelative

AssetId getRelative(AssetId asset,
                    String locale)

Get a relative of a given asset using the preferred locale

Parameters:

asset - the asset

locale - the interested locale

Returns:

the id for the given locale relative

makeLink

String makeLink(LinkInfo linkInfo)
         throws AssetAccessException

Generate a link given asset, template name and LinkInfo

Parameters:

linkInfo - the link information

Returns:

generated link

Throws:

AssetAccessException - an AssetAccessException

makeBlobLink

String makeBlobLink(BlobLinkInfo linkInfo)
             throws AssetAccessException

Generate a blob link given table, identifierColumnName, identifier, and columnname with given BlobLinkInfo

Parameters:

linkInfo - the blob link information

Returns:

the generated blob link

Throws:

AssetAccessException - an AssetAccessException

getSegments

List<AssetId> getSegments(String alias,
                          String profileName,
                          Map<String,Object> profile,
                          String sitename)

Get the segments that the visitor belongs to with visitor alias and visitor attributes

Parameters:

alias - the visitor alias

profileName - the name of the visitor profile.

profile - the visitor's profile (which is a map containing the attributes).

sitename - the site name

Returns:

the list of segments that the visitor belongs to

retainSegments

List<AssetId> retainSegments(String alias,
                             String profileName,
                             Map<String,Object> profile,
                             String segments,
                             String sitename)

Get the segments from the specified list that the visitor belongs to with visitor alias and visitor attributes

Parameters:

alias - the visitor alias

profileName - the name of the visitor profile.

profile - the visitor's profile (which is a map containing the attributes).

segments - the list of segment names separated by ","

sitename - the site name

Returns:

the list of segments that the visitor belongs to

getRecommendations

List<RecommendedAssetId> getRecommendations(String recommendationName,
                                            String alias,
                                            String profileName,
                                            Map<String,Object> profile,
                                            String segments,
                                            String sitename,
                                            boolean keepSegments)
                                     throws AssetAccessException

Get a list of recommended assets

Parameters:

recommendationName - the recommendation asset name to retrieve assets from

alias - the visitor alias

profileName - the name of the visitor profile.

profile - the visitor's profile (which is a map containing the attributes).

segments - the list of segment names separated by "," if known

sitename - the site name

Returns:

the list of recommended assets from the recommendation

Throws:

AssetAccessException - an AssetAccessException

isAttributeExist

boolean isAttributeExist(AssetData assetData,
                         String attribute)

Check if an Attribute exist in current assetData

Parameters:

assetData - the AssetData

attribute - the attribute name to check

Returns:

true if the attribute exists in AssetData, false otherwise

filterSingleAsset

AssetId filterSingleAsset(AssetId asset,
                          String desiredLocale,
                          String dimensionSetName)
                   throws com.fatwire.mda.DimensionException

Filter an asset based on a DimensionSet and a preferred locale

Parameters:

asset - the asset to filter

desiredLocale - the preferred locale

dimensionSetName - name of the DimensionSet to be used

Returns:

the filtered asset

Throws:

com.fatwire.mda.DimensionException - an DimensionException

getRelatives

Collection<AssetId> getRelatives(AssetId assetId)

Retrieve the relatives of a given asset in a Collection

Parameters:

assetId - the asset id of interested asset

Returns:

Collection of relative asset ids

getImmediateChildren

List<AssetId> getImmediateChildren(String siteName,
                                   AssetId assetId)

Get the immediate children of a given flex parent asset

Parameters:

siteName - the site name of the site children are interested in

assetId - the asset id

Returns:

the list of immediate flex children of the given flex parent

getAssetByName

AssetId getAssetByName(String site,
                       String assetType,
                       String assetName)

Retrieve an asset id from an asset name; for the possible multiple returns (assets with same names), we will return the first asset from the list

Parameters:

site - the site name

assetType - the asset type

assetName - the asset name

Returns:

the first AssetId returned

processEmbeddedLink

String processEmbeddedLink(String data)

Process the embeddedLink inside a String/Text attribute and return the processed result

Parameters:

data - the attribute value that needs to be processed

Returns:

the processed data

processEmbeddedLink

String processEmbeddedLink(InputStream data)

Process the embeddedLink inside a binary attribute and return the processed result

Parameters:

data - the attribute value that needs to be processed

Returns:

the processed data

executeContentQuery

List<AssetResultRow> executeContentQuery(String siteName,
                                         Long assetId,
                                         String assetName,
                                         int limit,
                                         String sortingField,
                                         boolean ascending)
                                  throws AssetAccessException

Execute a ContentQuery to retrieve the results

Parameters:

siteName - the site name

assetId - the ContentQuery id

assetName - the ContentQuery name, one of the id or name needs to present for this method to work

limit - the limit of how many assets will be returned

sortingField - the sorting field to sort the results

ascending - whether sort in ascending or descending order

Returns:

the list of AssetResultRow returned by the ContentQuery

Throws:

AssetAccessException

getPublicationId

Long getPublicationId(String assetName)

Get the publication id given a publication name

Parameters:

assetName - the publication name

Returns:

the publication id returned for that name

isAssetInSite

boolean isAssetInSite(AssetId asset,
                      String site)