org.alfresco.wcm.client

Interface AssetFactory

All Known Implementing Classes:

AssetFactoryCmisImpl, AssetFactoryWebscriptImpl, CachingAssetFactoryImpl

public interface AssetFactory

An interface for the retrieval of Asset objects

Author:

Brian

Method Summary

Methods

Modifier and Type	Method and Description
SearchResults	findByQuery(Query query) Execute the specified query and return the results
Asset	getAssetById(String id) Obtain the asset with the specified identifier.
Asset	getAssetById(String id, boolean deferredLoad) Similar to getAssetById(String), but if deferredLoad is set to true then this operation does not attempt to load the asset until a subsequent operation on it makes it necessary.
List<Asset>	getAssetsById(Collection<String> ids) Obtain a list of assets with the identifiers contained by the supplied collection of identifiers.
List<Asset>	getAssetsById(Collection<String> ids, boolean deferredLoad) Similar to getAssetsById(Collection), but if deferredLoad is set to true then this operation will not actually load the assets.
ContentStream	getContentStream(String assetId)
Date	getModifiedTimeOfAsset(String assetId) Fetch the modified time of a specified asset from the repository
Map<String,Date>	getModifiedTimesOfAssets(Collection<String> assetIds) Fetch the modified times of the assets identified in the supplied collection.
Map<String,Rendition>	getRenditions(String assetId) Retrieve all the renditions of the specified asset
Asset	getSectionAsset(String sectionId, String assetName) Loads the asset with the specified name that is located in the specified section.
Asset	getSectionAsset(String sectionId, String assetName, boolean wildcardsAllowedInName) Similar to getSectionAsset(String, String), but if wildcardsAllowedInName is set to true then this operation will allow wildcards in the specified assetName.
Map<String,List<String>>	getSourceRelationships(String assetId) Retrieve the identifiers of all assets that are related to the specified one, where the specified asset is the source of the relationship.

Method Detail

getAssetById

Asset getAssetById(String id)

Obtain the asset with the specified identifier.

Parameters:

id -

Returns:

the asset with the given identifier or null if not found

getAssetsById

List<Asset> getAssetsById(Collection<String> ids)

Obtain a list of assets with the identifiers contained by the supplied collection of identifiers.

Parameters:

ids -

Returns:

A list of assets. Each returned asset will have an identifier contained by the supplied collection of identifiers, but it is possible that not all of the requested assets will be returned (if they don't exist, for example). Therefore the size of the returned list will be less than or equal to the size of the the supplied collection of identifiers. If the supplied collection is ordered then the returned list of assets will retain the same ordering.

getAssetById

Asset getAssetById(String id,
                 boolean deferredLoad)

Similar to getAssetById(String), but if deferredLoad is set to true then this operation does not attempt to load the asset until a subsequent operation on it makes it necessary. Note that this operation may not even check that the requested asset exists.

Parameters:

id -

deferredLoad -

Returns:

getAssetsById

List<Asset> getAssetsById(Collection<String> ids,
                        boolean deferredLoad)

Similar to getAssetsById(Collection), but if deferredLoad is set to true then this operation will not actually load the assets. They will be loaded if a subsequent operation needs them to be.

Parameters:

ids -

deferredLoad -

Returns:

getSectionAsset

Asset getSectionAsset(String sectionId,
                    String assetName)

Loads the asset with the specified name that is located in the specified section.

Parameters:

sectionId -

assetName -

Returns:

The corresponding asset or null if not found.

getSectionAsset

Asset getSectionAsset(String sectionId,
                    String assetName,
                    boolean wildcardsAllowedInName)

Similar to getSectionAsset(String, String), but if wildcardsAllowedInName is set to true then this operation will allow wildcards in the specified assetName. Permitted wildcards are '_' to match any single character and '%' to match any sequence of characters. These special characters may be escaped with a preceding '\' if their literal value is needed.

Parameters:

sectionId -

assetName -

wildcardsAllowedInName -

Returns:

findByQuery

SearchResults findByQuery(Query query)

Execute the specified query and return the results

Parameters:

query -

Returns:

getSourceRelationships

Map<String,List<String>> getSourceRelationships(String assetId)

Retrieve the identifiers of all assets that are related to the specified one, where the specified asset is the source of the relationship.

Parameters:

assetId -

Returns:

A map in which the keys are the names of the relationships and the values are lists of asset identifiers that are related to the specified asset via that kind of relationship.

getRenditions

Map<String,Rendition> getRenditions(String assetId)

Retrieve all the renditions of the specified asset

Parameters:

assetId -

Returns:

A map in which a key is the kind of the rendition and the value is the rendition itself

getModifiedTimeOfAsset

Date getModifiedTimeOfAsset(String assetId)

Fetch the modified time of a specified asset from the repository

Parameters:

assetId -

Returns:

The modified time of the specified asset or null if the asset could not be found

getModifiedTimesOfAssets

Map<String,Date> getModifiedTimesOfAssets(Collection<String> assetIds)

Fetch the modified times of the assets identified in the supplied collection.

Parameters:

assetIds -

Returns:

A map in which a key is the identifier of an asset and the value is the modified time of that asset. Note that the returned map may contain fewer entries than the supplied collection of identifiers, as any assets that could not be found in the repository are omitted.

getContentStream

ContentStream getContentStream(String assetId)