org.alfresco.service.cmr.publishing

Interface PublishingService

All Known Implementing Classes:

PublishServiceImpl

public interface PublishingService

Since:

4.0

Author:

Brian

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelPublishingEvent(String id) Request that the specified publishing event be cancelled.
PublishingDetails	createPublishingDetails() A factory method to create an empty publishing package that can be populated before being passed into a call to the PublishingQueue.scheduleNewEvent(PublishingDetails) operation.
List<PublishingEvent>	getPublishEventsForNode(org.alfresco.service.cmr.repository.NodeRef publishedNode) Retrieve a list of publishing events for which the specified node was published.
PublishingEvent	getPublishingEvent(String id) Retrieve the publishing event that has the specified identifier
List<PublishingEvent>	getUnpublishEventsForNode(org.alfresco.service.cmr.repository.NodeRef unpublishedNode) Retrieve a list of publishing events for which the specified node was unpublished.
String	scheduleNewEvent(PublishingDetails publishingDetails) Adds the supplied publishing package onto the queue.

Method Detail

getPublishingEvent

@NotAuditable
PublishingEvent getPublishingEvent(String id)

Retrieve the publishing event that has the specified identifier

Parameters:

id - The identifier of the required publishing event

Returns:

The PublishingEvent object that corresponds to the requested identifier or null if no such publishing event can be located

getPublishEventsForNode

@NotAuditable
List<PublishingEvent> getPublishEventsForNode(org.alfresco.service.cmr.repository.NodeRef publishedNode)

Retrieve a list of publishing events for which the specified node was published.

Parameters:

publishedNode - The node that was published.

Returns:

A list of PublishingEvents.

getUnpublishEventsForNode

@NotAuditable
List<PublishingEvent> getUnpublishEventsForNode(org.alfresco.service.cmr.repository.NodeRef unpublishedNode)

Retrieve a list of publishing events for which the specified node was unpublished.

Parameters:

unpublishedNode - The node that was unpublished.

Returns:

A list of PublishingEvents.

cancelPublishingEvent

@Auditable(parameters="id")
void cancelPublishingEvent(String id)

Request that the specified publishing event be cancelled. This call will cancel the identified publishing event immediately if it hasn't been started. If it has been started but not yet completed then the request for cancellation will be recorded, and acted upon when (and if) possible.

Parameters:

id - The identifier of the publishing event that is to be cancelled.

createPublishingDetails

@NotAuditable
PublishingDetails createPublishingDetails()

A factory method to create an empty publishing package that can be populated before being passed into a call to the PublishingQueue.scheduleNewEvent(PublishingDetails) operation.

Returns:

A publishing package that can be populated before being placed on the publishing queue.

scheduleNewEvent

@Auditable
String scheduleNewEvent(PublishingDetails publishingDetails)

Adds the supplied publishing package onto the queue.

Parameters:

publishingDetails - The publishing package that is to be enqueued

Returns:

The identifier of the newly scheduled event