Package org.opencms.workflow

Interface I_CmsPublishResourceFormatter

All Known Implementing Classes:

CmsDefaultPublishResourceFormatter, CmsExtendedPublishResourceFormatter

public interface I_CmsPublishResourceFormatter

'Formats' a ResourceMap containing resources for publishing by creating a list of CmsPublishResource beans with the appropriate status informations to display.

Method Summary

Modifier and Type	Method	Description
List<CmsPublishResource>	getPublishResources()	Gets the publish resource beans created by this formatter.
void	initialize(CmsPublishOptions options, CmsPublishRelationFinder.ResourceMap resources)	Initializes the formatter.

Method Details

getPublishResources

List<CmsPublishResource> getPublishResources()
                                      throws CmsException

Gets the publish resource beans created by this formatter.

Returns:

the publish resource beans

Throws:

CmsException - if something goes wrong

initialize

void initialize(CmsPublishOptions options,
 CmsPublishRelationFinder.ResourceMap resources)
         throws CmsException

Initializes the formatter.

Parameters:

options - the publish options

resources - the publish resources

Throws:

CmsException - in case something goes wrong