org.cristalise.kernel.persistency.outcome.OutcomeInitiator Maven / Gradle / Ivy

Go to download
/**
 * This file is part of the CRISTAL-iSE kernel.
 * Copyright (c) 2001-2015 The CRISTAL Consortium. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * http://www.fsf.org/licensing/licenses/lgpl.html
 */
package org.cristalise.kernel.persistency.outcome;

import org.cristalise.kernel.common.InvalidDataException;
import org.cristalise.kernel.entity.agent.Job;


/**
 * OutcomeInitator can be defined to construct an initial state of an Outcome
 */
public interface OutcomeInitiator {

    /**
     * Constructs and initialises the Outcome string (XML)
     * 
     * @param job the Job containing information about the Outcome to be constructed
     * @return XML string
     */
    public String initOutcome(Job job) throws InvalidDataException;

    /**
     * Constructs and initialises the Outcome object
     * 
     * @param job the Job containing information about the Outcome to be constructed
     * @return Outcome object
     */
    public Outcome initOutcomeInstance(Job job) throws InvalidDataException;
}