com.sdl.web.api.meta

Interface WebComponentPresentationMetaFactory

public interface WebComponentPresentationMetaFactory

Provides access to ComponentPresentationMeta that can be obtained using the combination of a component and template id, specified either as a numbers or as TCM URIs. Each instance is specifically linked to a publication when an instance is created. This publication id is always used when getting ComponentPresentationMeta objects via getMeta methods

Method Summary

Modifier and Type	Method and Description
com.tridion.meta.ComponentPresentationMeta	getMeta(int componentId, int componentTemplateId) Returns the ComponentPresentationMeta for the given [componentId] and [componentTemplateId] with the publication of this ComponentPresentationMetaFactory instance.
com.tridion.meta.ComponentPresentationMeta	getMeta(String componentURI, String componentTemplateURI) Returns the ComponentPresentationMeta for the given [componentURI] and [componentTemplateURI] with the publication of this ComponentPresentationMetaFactory instance.
Collection<com.tridion.meta.ComponentPresentationMeta>	getMetaByComponent(String componentURI) Return a collection of ComponentPresentationMeta's available for the given component.
com.tridion.meta.ComponentPresentationMeta[]	getTaxonomyComponentPresentationMetas(com.tridion.taxonomies.Keyword[] taxonomyKeywords, String templateURI, boolean includeBranchedKeywords) This retrieves all ComponentPresentationMetas for the specified taxonomy keywords, either directly linked to the keyword or a branch/child of the specified keyword.
com.tridion.meta.ComponentPresentationMeta[]	getTaxonomyComponentPresentationMetas(com.tridion.taxonomies.Keyword taxonomyKeyword, String templateURI, boolean includeBranchedKeywords) This retrieves all ComponentPresentationMetas for the specified taxonomy keyword, either directly linked to the keyword or a branch/child of the specified keyword.
com.tridion.taxonomies.Keyword[]	getTaxonomyKeywords(String[] componentURIs, com.tridion.taxonomies.Keyword[] contextKeywords, WebTaxonomyFilter taxonomyFilter) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.
com.tridion.taxonomies.Keyword[]	getTaxonomyKeywords(String componentURI, com.tridion.taxonomies.Keyword[] contextKeywords, WebTaxonomyFilter taxonomyFilter) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.
com.tridion.taxonomies.Keyword[]	getTaxonomyKeywords(String taxonomyURI, String[] componentURIs, com.tridion.taxonomies.Keyword[] contextKeywords, WebTaxonomyFilter taxonomyFilter) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.
com.tridion.taxonomies.Keyword[]	getTaxonomyKeywords(String taxonomyURI, String componentURI, com.tridion.taxonomies.Keyword[] contextKeywords, WebTaxonomyFilter taxonomyFilter) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Method Detail

getMeta

com.tridion.meta.ComponentPresentationMeta getMeta(int componentId,
                                                   int componentTemplateId)

Returns the ComponentPresentationMeta for the given [componentId] and [componentTemplateId] with the publication of this ComponentPresentationMetaFactory instance.

Parameters:

componentId - item id of the component

componentTemplateId - item id of the template

Returns:

ComponentPresentationMeta or null in case of errors or when no ComponentPresentationMeta can be found

getMeta

com.tridion.meta.ComponentPresentationMeta getMeta(String componentURI,
                                                   String componentTemplateURI)

Returns the ComponentPresentationMeta for the given [componentURI] and [componentTemplateURI] with the publication of this ComponentPresentationMetaFactory instance.

Parameters:

componentURI - TCMURI of the component

componentTemplateURI - TCMURI of the template

Returns:

ComponentPresentationMeta or null in case of errors or when no ComponentPresentationMeta can be found

getMetaByComponent

Collection<com.tridion.meta.ComponentPresentationMeta> getMetaByComponent(String componentURI)

Return a collection of ComponentPresentationMeta's available for the given component. If nothing matches an empty collection will be returned.

Parameters:

componentURI - The uri of the component.

Returns:

A collection containg 0 or more ComponentPresentationMeta's.

getTaxonomyComponentPresentationMetas

com.tridion.meta.ComponentPresentationMeta[] getTaxonomyComponentPresentationMetas(com.tridion.taxonomies.Keyword taxonomyKeyword,
                                                                                   String templateURI,
                                                                                   boolean includeBranchedKeywords)
                                                                            throws com.tridion.broker.StorageException

This retrieves all ComponentPresentationMetas for the specified taxonomy keyword, either directly linked to the keyword or a branch/child of the specified keyword.

Parameters:

taxonomyKeyword - The taxonomy keyword the ComponentPresentationMetas must be related to

templateURI - The templateURI of the ComponentPresentationMetas

includeBranchedKeywords - True if all the childkeywords of the specified keyword should be included

Returns:

A list of ComponentPresentationMetas, empty list if nothing was found

Throws:

com.tridion.broker.StorageException - If unable to retrieve ComponentPresentationMetas for taxonomyfacet

getTaxonomyComponentPresentationMetas

com.tridion.meta.ComponentPresentationMeta[] getTaxonomyComponentPresentationMetas(com.tridion.taxonomies.Keyword[] taxonomyKeywords,
                                                                                   String templateURI,
                                                                                   boolean includeBranchedKeywords)
                                                                            throws com.tridion.broker.StorageException

This retrieves all ComponentPresentationMetas for the specified taxonomy keywords, either directly linked to the keyword or a branch/child of the specified keyword. Only ComponentPresentationMetas which are related to all of the keywords are retrieved, this is an AND case.

Parameters:

taxonomyKeywords - The combined taxonomy keywords the ComponentPresentationMetas must be related to

templateURI - The templateURI of the ComponentPresentationMetas

includeBranchedKeywords - True if all the childkeywords of the specified keywords should be included

Returns:

A list of ComponentPresentationMetas, empty list if nothing was found

Throws:

com.tridion.broker.StorageException - If unable to retrieve ComponentPresentationMetas for taxonomyfacet

getTaxonomyKeywords

com.tridion.taxonomies.Keyword[] getTaxonomyKeywords(String[] componentURIs,
                                                     com.tridion.taxonomies.Keyword[] contextKeywords,
                                                     WebTaxonomyFilter taxonomyFilter)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

componentURIs - THe URIs of the components to search keywords for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

taxonomyFilter - The filter to apply to the found taxonomyFacets

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getTaxonomyKeywords

com.tridion.taxonomies.Keyword[] getTaxonomyKeywords(String componentURI,
                                                     com.tridion.taxonomies.Keyword[] contextKeywords,
                                                     WebTaxonomyFilter taxonomyFilter)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

componentURI - THe URI of the component to search facets for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

taxonomyFilter - The filter to apply to the found taxonomyFacets

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getTaxonomyKeywords

com.tridion.taxonomies.Keyword[] getTaxonomyKeywords(String taxonomyURI,
                                                     String componentURI,
                                                     com.tridion.taxonomies.Keyword[] contextKeywords,
                                                     WebTaxonomyFilter taxonomyFilter)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

taxonomyURI - The URI of the Taxonomy

componentURI - THe URI of the component to search facets for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

taxonomyFilter - The filter to apply to the found taxonomyFacets

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getTaxonomyKeywords

com.tridion.taxonomies.Keyword[] getTaxonomyKeywords(String taxonomyURI,
                                                     String[] componentURIs,
                                                     com.tridion.taxonomies.Keyword[] contextKeywords,
                                                     WebTaxonomyFilter taxonomyFilter)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

taxonomyURI - The URI of the Taxonomy

componentURIs - THe URIs of the components to search keywords for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

taxonomyFilter - The filter to apply to the found taxonomyFacets

Returns:

An array of found Keywords, a merged keyword array without duplicates.