mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
Updated the Javadoc on the Publishing Foundation API
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@29407 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
@@ -21,6 +21,7 @@ package org.alfresco.service.cmr.publishing;
|
||||
|
||||
import java.util.Set;
|
||||
|
||||
import org.alfresco.service.cmr.publishing.channels.Channel;
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
|
||||
/**
|
||||
@@ -30,7 +31,19 @@ import org.alfresco.service.cmr.repository.NodeRef;
|
||||
*/
|
||||
public interface StatusUpdate
|
||||
{
|
||||
/**
|
||||
* @return the status message to be published.
|
||||
*/
|
||||
String getMessage();
|
||||
|
||||
/**
|
||||
* @return a {@link Set} of String identifiers indicating which {@link Channel} the status update will be published to.
|
||||
*/
|
||||
Set<String> getChannelIds();
|
||||
|
||||
/**
|
||||
* Returns a {@link NodeRef}. The returned {@link NodeRef} is one of the {@link NodeRef}s to be published by the associated {@link PublishingEvent}. The status update message will have a URL appended to it which links to the published resource represented by this {@link NodeRef}.
|
||||
* @return the {@link NodeRef} to link to.
|
||||
*/
|
||||
NodeRef getNodeToLinkTo();
|
||||
}
|
||||
|
Reference in New Issue
Block a user