com.adobe.granite.workflow.exec.HistoryItem Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2012 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.adobe.granite.workflow.exec;

import java.util.Date;

/**
 * Contains information about the history of a {@link Workflow}.
 *
 * @see com.adobe.granite.workflow.WorkflowSession#getHistory(Workflow)
 */
public interface HistoryItem {
    /**
     * The history comment (entered while advancing, starting, terminating)
     *
     * @return comment
     */
    String getComment();

    /**
     * The action that got issued on the {@link com.adobe.granite.workflow.exec.WorkItem}
     *
     * @return action descriptor as string
     */
    String getAction();

    /**
     * Date when an action {@link com.adobe.granite.workflow.exec.WorkItem}
     * got issued that caused this HistoryItem
     *
     * @return date
     */
    Date getDate();

    /**
     * User who triggered the  action {@link com.adobe.granite.workflow.exec.WorkItem}
     * hat caused this HistoryItem
     *
     * @return the user id
     */
    String getUserId();

    /**
     * Returns the previous history item.
     *
     * @return the previous {@link HistoryItem}
     *         if available otherwise null
     */
    HistoryItem getPreviousHistoryItem();

    /**
     * Returns the next history item.
     *
     * @return the next {@link HistoryItem}
     *         if available otherwise null
     */
    HistoryItem getNextHistryItem();

    /**
     * Returns the corresponding {@link WorkItem}
     *
     * @return {@link WorkItem}
     */
    WorkItem getWorkItem();
}