mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-29 15:21:53 +00:00
79093bd8ae
Covers spacing, trailing {, @since tags, tabs and copyright headers.
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@30211 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
91 lines
2.6 KiB
Java
91 lines
2.6 KiB
Java
/*
|
|
* Copyright (C) 2005-2011 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.Date;
|
|
|
|
import org.alfresco.service.cmr.publishing.channels.Channel;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
|
|
|
|
/**
|
|
* @author Brian
|
|
* @author Nick Smith
|
|
* @since 4.0
|
|
*/
|
|
public interface PublishingEvent extends Comparable<PublishingEvent>
|
|
{
|
|
/**
|
|
* @return a unique {@link String} identifier for this {@link PublishingEvent}
|
|
*/
|
|
String getId();
|
|
|
|
/**
|
|
* @return the current {@link Status} of this {@link PublishingEvent}.
|
|
*/
|
|
Status getStatus();
|
|
|
|
/**
|
|
* @return the date and time when this {@link PublishingEvent} is scheduled to publish its content.
|
|
*/
|
|
Calendar getScheduledTime();
|
|
|
|
/**
|
|
* @return the {@link PublishingPackage} containing all the {@link NodeRef}s to be published and unpublished.
|
|
*/
|
|
PublishingPackage getPackage();
|
|
|
|
/**
|
|
* @return the date and time when this {@link PublishingEvent} was created.
|
|
*/
|
|
Date getCreatedTime();
|
|
|
|
/**
|
|
* @return the name of the user who created this {@link PublishingEvent}.
|
|
*/
|
|
String getCreator();
|
|
|
|
/**
|
|
* @return the date and time when this {@link PublishingEvent} was last modified.
|
|
*/
|
|
Date getModifiedTime();
|
|
|
|
/**
|
|
* @return the name of the user who last modified this {@link PublishingEvent}.
|
|
*/
|
|
String getModifier();
|
|
|
|
/**
|
|
* @return the comment associatied with this {@link PublishingEvent}.
|
|
*/
|
|
String getComment();
|
|
|
|
/**
|
|
* @return a unique identifier indicating which {@link Channel} this {@link PublishingEvent} publishes to.
|
|
*/
|
|
String getChannelId();
|
|
|
|
/**
|
|
* @return the {@link StatusUpdate} information, if any.
|
|
*/
|
|
StatusUpdate getStatusUpdate();
|
|
}
|