org.alfresco.service.cmr.publishing

Interface PublishingDetails

All Known Implementing Classes:

PublishingDetailsImpl

public interface PublishingDetails

A simple DTO used to gather parameters for scheduling a Publishing Event.

Since:

4.0

Author:

Brian, Nick Smith

Method Summary

Modifier and Type	Method and Description
PublishingDetails	addNodesToPublish(Collection<org.alfresco.service.cmr.repository.NodeRef> nodesToPublish)
PublishingDetails	addNodesToPublish(org.alfresco.service.cmr.repository.NodeRef... nodesToPublish)
PublishingDetails	addNodesToUnpublish(Collection<org.alfresco.service.cmr.repository.NodeRef> nodesToRemove)
PublishingDetails	addNodesToUnpublish(org.alfresco.service.cmr.repository.NodeRef... nodesToRemove)
PublishingDetails	addStatusUpdateChannels(Collection<String> channelIds)
PublishingDetails	addStatusUpdateChannels(String... channelIds)
String	getComment()
Set<org.alfresco.service.cmr.repository.NodeRef>	getNodesToPublish()
Set<org.alfresco.service.cmr.repository.NodeRef>	getNodesToUnpublish()
org.alfresco.service.cmr.repository.NodeRef	getNodeToLinkTo()
String	getPublishChannelId()
Calendar	getSchedule()
String	getStatusMessage()
Set<String>	getStatusUpdateChannels()
PublishingDetails	setComment(String comment)
PublishingDetails	setPublishChannelId(String channelId)
PublishingDetails	setSchedule(Calendar schedule)
PublishingDetails	setStatusMessage(String message)
PublishingDetails	setStatusNodeToLinkTo(org.alfresco.service.cmr.repository.NodeRef nodeToLinkTo)

Method Detail

addNodesToUnpublish

PublishingDetails addNodesToUnpublish(org.alfresco.service.cmr.repository.NodeRef... nodesToRemove)

addNodesToUnpublish

PublishingDetails addNodesToUnpublish(Collection<org.alfresco.service.cmr.repository.NodeRef> nodesToRemove)

addNodesToPublish

PublishingDetails addNodesToPublish(org.alfresco.service.cmr.repository.NodeRef... nodesToPublish)

addNodesToPublish

PublishingDetails addNodesToPublish(Collection<org.alfresco.service.cmr.repository.NodeRef> nodesToPublish)

setPublishChannelId

PublishingDetails setPublishChannelId(String channelId)

setComment

PublishingDetails setComment(String comment)

setSchedule

PublishingDetails setSchedule(Calendar schedule)

setStatusMessage

PublishingDetails setStatusMessage(String message)

setStatusNodeToLinkTo

PublishingDetails setStatusNodeToLinkTo(org.alfresco.service.cmr.repository.NodeRef nodeToLinkTo)

addStatusUpdateChannels

PublishingDetails addStatusUpdateChannels(Collection<String> channelIds)

addStatusUpdateChannels

PublishingDetails addStatusUpdateChannels(String... channelIds)

getComment

String getComment()

Returns:

the comment

getStatusMessage

String getStatusMessage()

Returns:

the message

getNodeToLinkTo

org.alfresco.service.cmr.repository.NodeRef getNodeToLinkTo()

Returns:

the nodeToLinkTo

getPublishChannelId

String getPublishChannelId()

Returns:

the publishChannelId

getSchedule

Calendar getSchedule()

Returns:

the schedule

getStatusUpdateChannels

Set<String> getStatusUpdateChannels()

getNodesToPublish

Set<org.alfresco.service.cmr.repository.NodeRef> getNodesToPublish()

Returns:

a Set of all the NodeRefs to be published.

getNodesToUnpublish

Set<org.alfresco.service.cmr.repository.NodeRef> getNodesToUnpublish()

Returns:

a Set of all the NodeRefs to be unpublished.