mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-29 15:21:53 +00:00
db158066a0
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@28957 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
65 lines
3.1 KiB
Java
65 lines
3.1 KiB
Java
/*
|
|
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
package org.alfresco.service.cmr.publishing;
|
|
|
|
import java.util.Calendar;
|
|
import java.util.Collection;
|
|
import java.util.List;
|
|
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
|
|
public interface PublishingQueue
|
|
{
|
|
/**
|
|
* A factory method to create an empty publishing package that can be populated before being passed into
|
|
* a call to the {@link PublishingQueue#scheduleNewEvent(PublishingPackage, String, Calendar, String, StatusUpdate)} operation.
|
|
* @return A publishing package that can be populated before being placed on the publishing queue.
|
|
*/
|
|
MutablePublishingPackage createPublishingPackage();
|
|
|
|
StatusUpdate createStatusUpdate(String message, NodeRef nodeToLinkTo, String... channelNames);
|
|
StatusUpdate createStatusUpdate(String message, NodeRef nodeToLinkTo, Collection<String> channelNames);
|
|
|
|
/**
|
|
* Adds the supplied publishing package onto the queue.
|
|
* @param publishingPackage The publishing package that is to be enqueued
|
|
* @param channelName The name of the channel that the package is to be published to
|
|
* @param schedule The time at which the new publishing event should be scheduled (optional - <code>null</code> indicates "as soon as possible")
|
|
* @param comment A comment to be stored with this new event (optional - may be <code>null</code>)
|
|
* @param statusUpdate TODO
|
|
* @return The identifier of the newly scheduled event
|
|
*/
|
|
String scheduleNewEvent(PublishingPackage publishingPackage, String channelName, Calendar schedule, String comment, StatusUpdate statusUpdate);
|
|
|
|
/**
|
|
* Retrieve a list of publishing events associated with this publishing environment, filtering them using the
|
|
* supplied PublishingEventFilter object (optional - may be <code>null</code>)
|
|
* @param filter The filter that is to be applied to the publishing events on this environment
|
|
* @return A list of PublishingEvent objects representing the publishing events that matched the supplied filter on this publishing environment
|
|
*/
|
|
List<PublishingEvent> getPublishingEvents(PublishingEventFilter filter);
|
|
|
|
/**
|
|
* A factory method that creates a {@link PublishingEventFilter} object.
|
|
* @return a new {@link PublishingEventFilter}.
|
|
*/
|
|
PublishingEventFilter createPublishingEventFilter();
|
|
}
|