com.sdl.web.api.dynamic

Interface WebComponentPresentationFactory

public interface WebComponentPresentationFactory

Interface used to retrieve the raw content of component presentations.

Method Summary

Modifier and Type	Method and Description
Collection<com.tridion.dcp.ComponentPresentation>	findAllComponentPresentations(int componentId) Retrieve a list of all component presentations for a component.
Collection<com.tridion.dcp.ComponentPresentation>	findAllComponentPresentations(int publicationId, int componentId) Retrieve a list of all component presentations for a component.
Collection<com.tridion.dcp.ComponentPresentation>	findAllComponentPresentations(String componentURI) Retrieve a list of all component presentations for a component.
com.tridion.dcp.ComponentPresentation	getComponentPresentation(int componentId, int templateId) Get a component presentation.
com.tridion.dcp.ComponentPresentation	getComponentPresentation(int publicationId, int componentId, int templateId) Get a component presentation.
com.tridion.dcp.ComponentPresentation	getComponentPresentation(String componentURI, String templateURI) Get a component presentation.
com.tridion.dcp.ComponentPresentation	getComponentPresentationWithHighestPriority(int componentId) Get the component presentation for a component that has the highest priority.
com.tridion.dcp.ComponentPresentation	getComponentPresentationWithHighestPriority(String componentURI) Get the component presentation for a component that has the highest priority.
com.tridion.dcp.ComponentPresentation	getComponentPresentationWithLowestPriority(int componentId) Get the component presentation for a component that has the lowest priority.
com.tridion.dcp.ComponentPresentation	getComponentPresentationWithLowestPriority(String componentURI) Get the component presentation for a component that has the lowest priority.
com.tridion.dcp.ComponentPresentation	getComponentPresentationWithOutputFormat(int componentId, String formatString) Get a component presentation for a component, with the given output format.
com.tridion.dcp.ComponentPresentation	getComponentPresentationWithOutputFormat(String componentURI, String formatString) Get a component presentation for a component, with the given output format.
com.tridion.dcp.ComponentPresentation	getComponentPresentationWithPriority(int componentId, int priority) Get a component presentation for a component, with the specified priority.
com.tridion.dcp.ComponentPresentation	getComponentPresentationWithPriority(String componentURI, int templatePriority) Get a component presentation for a component, with the specified priority.
com.tridion.dcp.ComponentPresentation[]	getTaxonomyComponentPresentations(com.tridion.taxonomies.Keyword[] taxonomyKeywords, String templateURI, boolean includeBranchedKeywords) This retrieves all ComponentPresentations for the specified taxonomy keyword, either directly linked to the keyword or a branch/child of the specified keyword.
com.tridion.dcp.ComponentPresentation[]	getTaxonomyComponentPresentations(com.tridion.taxonomies.Keyword taxonomyKeyword, String templateURI, boolean includeBranchedKeywords) This retrieves all ComponentPresentations 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

getComponentPresentation

com.tridion.dcp.ComponentPresentation getComponentPresentation(int componentId,
                                                               int templateId)

Get a component presentation.

Parameters:

componentId - The component of the component presentation.

templateId - The template of the component presentation.

Returns:

The matching component presentation, or null if the component presentation could not be found.

getComponentPresentation

com.tridion.dcp.ComponentPresentation getComponentPresentation(String componentURI,
                                                               String templateURI)

Get a component presentation.

Parameters:

componentURI - The TCM URI of the component in the component presentation.

templateURI - The TCM URI of the template in the component presentation.

Returns:

The matching component presentation, or null if the component presentation could not be found.

getTaxonomyComponentPresentations

com.tridion.dcp.ComponentPresentation[] getTaxonomyComponentPresentations(com.tridion.taxonomies.Keyword taxonomyKeyword,
                                                                          String templateURI,
                                                                          boolean includeBranchedKeywords)
                                                                   throws com.tridion.broker.StorageException

This retrieves all ComponentPresentations 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 ComponentPresentation must be related to

templateURI - The templateURI of the ComponentPresentations

includeBranchedKeywords - True if all the childKeywords of the specified facet should be included

Returns:

A list of ComponentPresentations, empty list if nothing was found

Throws:

com.tridion.broker.StorageException - If unable to retrieve ComponentPresentations for keyword

getTaxonomyComponentPresentations

com.tridion.dcp.ComponentPresentation[] getTaxonomyComponentPresentations(com.tridion.taxonomies.Keyword[] taxonomyKeywords,
                                                                          String templateURI,
                                                                          boolean includeBranchedKeywords)
                                                                   throws com.tridion.broker.StorageException

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

Parameters:

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

templateURI - The templateURI of the ComponentPresentations

includeBranchedKeywords - True if all the childKeywords of the specified facet should be included

Returns:

A list of ComponentPresentations, empty list if nothing was found

Throws:

com.tridion.broker.StorageException - If unable to retrieve ComponentPresentations for keyword

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 content 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 keywords

Returns:

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

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 content 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 keywords

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 content 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 keywords

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, may be null if no specific taxonomy is required

componentURIs - THe URIs of the content 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 keywords

Returns:

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

getComponentPresentation

com.tridion.dcp.ComponentPresentation getComponentPresentation(int publicationId,
                                                               int componentId,
                                                               int templateId)

Get a component presentation.

Parameters:

publicationId - The publication the component presentation is in.

componentId - The component of the component presentation.

templateId - The template of the component presentation.

Returns:

The matching component presentation, or null if the component presentation could not be found.

getComponentPresentationWithHighestPriority

com.tridion.dcp.ComponentPresentation getComponentPresentationWithHighestPriority(int componentId)

Get the component presentation for a component that has the highest priority.

(Note: The results of this method are currently not cached)

Parameters:

componentId - The component to get a component presentation for.

Returns:

The matching component presentation, or null if no component presentation for the component could be found.

getComponentPresentationWithHighestPriority

com.tridion.dcp.ComponentPresentation getComponentPresentationWithHighestPriority(String componentURI)

Get the component presentation for a component that has the highest priority.

(Note: The results of this method are currently not cached)

Parameters:

componentURI - The component to get a component presentation for.

Returns:

The matching component presentation, or null if no component presentation for the component could be found.

getComponentPresentationWithLowestPriority

com.tridion.dcp.ComponentPresentation getComponentPresentationWithLowestPriority(int componentId)

Get the component presentation for a component that has the lowest priority.

(Note: The results of this method are currently not cached)

Parameters:

componentId - The component to get a component presentation for.

Returns:

The matching component presentation, or null if no component presentation for the component could be found.

getComponentPresentationWithLowestPriority

com.tridion.dcp.ComponentPresentation getComponentPresentationWithLowestPriority(String componentURI)

Get the component presentation for a component that has the lowest priority.

(Note: The results of this method are currently not cached)

Parameters:

componentURI - The TCM URI of the component to get a component presentation for.

Returns:

The matching component presentation, or null if no component presentation for the component could be found.

getComponentPresentationWithPriority

com.tridion.dcp.ComponentPresentation getComponentPresentationWithPriority(int componentId,
                                                                           int priority)

Get a component presentation for a component, with the specified priority.

(Note: The results of this method are currently not cached)

Parameters:

componentId - The component to get a component presentation for.

priority - The priority of the to be found component presentation.

Returns:

A matching component presentation, or null if no match could be found.

getComponentPresentationWithPriority

com.tridion.dcp.ComponentPresentation getComponentPresentationWithPriority(String componentURI,
                                                                           int templatePriority)

Get a component presentation for a component, with the specified priority.

(Note: The results of this method are currently not cached)

Parameters:

componentURI - The TCM URI of the component to get a component presentation for.

templatePriority - The priority of the to be found component presentation.

Returns:

A matching component presentation, or null if no match could be found.

getComponentPresentationWithOutputFormat

com.tridion.dcp.ComponentPresentation getComponentPresentationWithOutputFormat(int componentId,
                                                                               String formatString)

Get a component presentation for a component, with the given output format.

(Note: The results of this method are currently not cached)

Parameters:

componentId - The component to find a component presentation for.

formatString - The output format the component presentation should have.

Returns:

A matching component presentation, or null if no match could be found.

getComponentPresentationWithOutputFormat

com.tridion.dcp.ComponentPresentation getComponentPresentationWithOutputFormat(String componentURI,
                                                                               String formatString)

Get a component presentation for a component, with the given output format.

(Note: The results of this method are currently not cached)

Parameters:

componentURI - The TCM URI of the component to find a component presentation for.

formatString - The output format the component presentation should have.

Returns:

A matching component presentation, or null if no match could be found.

findAllComponentPresentations

Collection<com.tridion.dcp.ComponentPresentation> findAllComponentPresentations(int componentId)

Retrieve a list of all component presentations for a component.

(Note: The results of this method are currently not cached)

Parameters:

componentId - The component to find

Returns:

A list of found component presentations.

findAllComponentPresentations

Collection<com.tridion.dcp.ComponentPresentation> findAllComponentPresentations(int publicationId,
                                                                                int componentId)

Retrieve a list of all component presentations for a component.

(Note: The results of this method are currently not cached)

Parameters:

componentId - The component to find

publicationId - The publicationId to find the components for

Returns:

A list of found component presentations.

findAllComponentPresentations

Collection<com.tridion.dcp.ComponentPresentation> findAllComponentPresentations(String componentURI)

Retrieve a list of all component presentations for a component.

(Note: The results of this method are currently not cached)

Parameters:

componentURI - The TCM URI of the relevant component

Returns:

A list of found component presentations.