CmsDefaultPublishResourceFormatter.I_PublishResourceValidator (OpenCms Core API, version 18.0)

All Known Implementing Classes:: CmsDefaultPublishResourceFormatter.AlreadyPublishedValidator, CmsDefaultPublishResourceFormatter.BlockingLockedValidator, CmsDefaultPublishResourceFormatter.NoPermissionsValidator

Enclosing class:: CmsDefaultPublishResourceFormatter

public static interface CmsDefaultPublishResourceFormatter.I_PublishResourceValidator

Validator which can exclude some resources from publishing and supplies a status object for the excluded resources.

Method Summary

Modifier and Type

Method

Description

Set<CmsResource>

findInvalidResources(Set<CmsResource> input)

Finds the resources which should be excluded.

CmsPublishResourceInfo

getInfoForResource(CmsResource resource)

Gets the status information for an excluded resource.

Method Details
- findInvalidResources
  
  Set<CmsResource> findInvalidResources(Set<CmsResource> input)
  
  Finds the resources which should be excluded.
  
  Parameters:
  
  input - the set of input resources
  
  Returns:
  
  the excluded resources
- getInfoForResource
  
  CmsPublishResourceInfo getInfoForResource(CmsResource resource) throws CmsException
  
  Gets the status information for an excluded resource.
  
  Parameters:
  
  resource - the resource for which to get the status
  
  Returns:
  
  the status for the resource
  
  Throws:
  
  CmsException - if something goes wrong