CaseMilestone.java

/*
 * 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;

/**
 * Represents intermediate goal within a case
 *
 */
public interface CaseMilestone {

    /**
     * Returns id of the milestone.
     * @return
     */
    String getId();
    /**
     * Returns name of the milestone.
     * @return
     */
    String getName();
    
    /**
     * Returns condition that will indicate this mile stone is achieved.  
     * @return
     */
    String getAchievementCondition();
    
    /**
     * Defines if this milestone is required before case completion.
     * @return
     */
    boolean isMandatory();
}