com.day.cq.workflow.exec.HistoryItem Maven / Gradle / Ivy

/*
 * Copyright 1997-2008 Day Management AG
 * Barfuesserplatz 6, 4001 Basel, Switzerland
 * All Rights Reserved.
 *
 * This software is the confidential and proprietary information of
 * Day Management AG, ("Confidential Information"). You shall not
 * disclose such Confidential Information and shall use it only in
 * accordance with the terms of the license agreement you entered into
 * with Day.
 */
package com.day.cq.workflow.exec;

import java.util.Date;

/**
 * HistoryItem...
 */
public interface HistoryItem {
    /**
     * The history comment (entered while advancing, starting, terminating)
     *
     * @return comment
     */
    String getComment();

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

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

    /**
     * User who triggered the  action {@link com.day.cq.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();
}