/*
* Copyright 2016 Red Hat, Inc. and/or its affiliates.
*
* 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.jbpm.casemgmt.api.model.instance;
import java.util.Date;
/**
* Represents single instance of a milestone in a case. As long as it's not achieved
* it can be still updated, once achieved it's read only.
*
*/
public interface CaseMilestoneInstance {
/**
* Returns id of the milestone.
* @return
*/
String getId();
/**
* Returns name of the milestone.
* @return
*/
String getName();
/**
* Indicates if this milestone is already achieved or not.
* @return
*/
boolean isAchieved();
/**
* In case this milestone is achieved, returns date at it was achieved.
* @return
*/
Date getAchievedAt();
/**
* Returns status of this milestone
* @return
*/
MilestoneStatus getStatus();
}