org.dd4t.providers

Interface ComponentPresentationProvider

public interface ComponentPresentationProvider

Dynamic Component Presentation Provider.

Note that this class is NOT used when fetching pages with static Component Presentations!

Method Summary

Methods

Modifier and Type	Method and Description
String	getDynamicComponentPresentation(int componentId, int publicationId) Retrieves content of a Dynamic Component Presentation by looking up its componentId and publicationId.
String	getDynamicComponentPresentation(int componentId, int templateId, int publicationId) Retrieves content of a Dynamic Component Presentation by looking up its componentId, templateId and publicationId.
ComponentPresentationResultItem<String>	getDynamicComponentPresentationItem(int componentId, int publicationId) Retrieves content of a Dynamic Component Presentation by looking up its componentId and publicationId.
ComponentPresentationResultItem<String>	getDynamicComponentPresentationItem(int componentId, int templateId, int publicationId) Retrieves content of a Dynamic Component Presentation by looking up its componentId, templateId and publicationId.
List<String>	getDynamicComponentPresentations(String[] itemUris, int templateId, int publicationId) Convenience method to obtain a list of component presentations for the same template id.

Method Detail

getDynamicComponentPresentation

String getDynamicComponentPresentation(int componentId,
                                     int publicationId)
                                       throws ItemNotFoundException,
                                              SerializationException

Retrieves content of a Dynamic Component Presentation by looking up its componentId and publicationId. A templateId is not provided, so the DCP with the highest linking priority is retrieved.

Note: This method performs significantly slower than getDynamicComponentPresentation(int, int, int)! Do provide a templateId!

Parameters:

componentId - int representing the Component item id

publicationId - int representing the Publication id of the DCP

Returns:

String representing the content of the DCP

Throws:

ItemNotFoundException - if the requested DCP does not exist

SerializationException - if something went wrong during deserialization

getDynamicComponentPresentation

String getDynamicComponentPresentation(int componentId,
                                     int templateId,
                                     int publicationId)
                                       throws ItemNotFoundException,
                                              SerializationException

Retrieves content of a Dynamic Component Presentation by looking up its componentId, templateId and publicationId.

Parameters:

componentId - int representing the Component item id

templateId - int representing the Component Template item id

publicationId - int representing the Publication id of the DCP

Returns:

String representing the content of the DCP

Throws:

ItemNotFoundException - if the requested DCP does not exist

SerializationException - if something went wrong during deserialization

getDynamicComponentPresentationItem

ComponentPresentationResultItem<String> getDynamicComponentPresentationItem(int componentId,
                                                                          int publicationId)
                                                                            throws ItemNotFoundException,
                                                                                   SerializationException

Retrieves content of a Dynamic Component Presentation by looking up its componentId and publicationId. A templateId is not provided, so the DCP with the highest linking priority is retrieved.

Note: This method performs significantly slower than getDynamicComponentPresentation(int, int, int)! Do provide a templateId!

Parameters:

componentId - int representing the Component item id

publicationId - int representing the Publication id of the DCP

Returns:

ComponentPresentationResultItem representing the DCP

Throws:

ItemNotFoundException - if the requested DCP does not exist

SerializationException - if something went wrong during deserialization

getDynamicComponentPresentationItem

ComponentPresentationResultItem<String> getDynamicComponentPresentationItem(int componentId,
                                                                          int templateId,
                                                                          int publicationId)
                                                                            throws ItemNotFoundException,
                                                                                   SerializationException

Retrieves content of a Dynamic Component Presentation by looking up its componentId, templateId and publicationId.

Parameters:

componentId - int representing the Component item id

templateId - int representing the Component Template item id

publicationId - int representing the Publication id of the DCP

Returns:

ComponentPresentationResultItem representing the DCP

Throws:

ItemNotFoundException - if the requested DCP does not exist

SerializationException - if something went wrong during deserialization

getDynamicComponentPresentations

List<String> getDynamicComponentPresentations(String[] itemUris,
                                            int templateId,
                                            int publicationId)
                                              throws ItemNotFoundException,
                                                     SerializationException

Convenience method to obtain a list of component presentations for the same template id.

Parameters:

itemUris - array of found Component TCM IDs

templateId - the CT Id to fetch DCPs on

publicationId - the current Publication Id

Returns:

a List of Component Presentations

Throws:

ItemNotFoundException

SerializationException