org.activiti.engine.task.Comment Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of activiti-engine Show documentation

The newest version!

/* Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.activiti.engine.task;

import java.util.Date;

import org.activiti.engine.TaskService;
import org.activiti.engine.api.internal.Internal;
import org.activiti.engine.history.HistoricData;

/** User comments that form discussions around tasks.
 * 
 * @see {@link TaskService#getTaskComments(String)
 *
 * @deprecated this interface and its implementations are going to be removed in future iterations
 * Comments doesn't belong to the Process/Task Runtime
 */
@Internal
@Deprecated
public interface Comment extends HistoricData {

  /** unique identifier for this comment */
  String getId();

  /** reference to the user that made the comment */
  String getUserId();

  /** time and date when the user made the comment */
  Date getTime();

  /** reference to the task on which this comment was made */
  String getTaskId();

  /** reference to the process instance on which this comment was made */
  String getProcessInstanceId();

  /** reference to the type given to the comment */
  String getType();

  /**
   * the full comment message the user had related to the task and/or process instance
   * 
   * @see TaskService#getTaskComments(String)
   */
  String getFullMessage();
}