org.drools.KBaseUnit Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of knowledge-api Show documentation

The Drools and jBPM public API which is backwards compatible between releases.

The newest version!

/*
 * Copyright 2015 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.
 * 
 *      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.drools;

import org.drools.KnowledgeBase;
import org.drools.builder.KnowledgeBuilderErrors;
import org.drools.runtime.StatefulKnowledgeSession;
import org.drools.runtime.StatelessKnowledgeSession;

/**
 * This class wraps the definition of a named KnowledgeBase defined in a KnowledgeJar
 * allowing to instance it and create new StatefulKnowledgeSession from it
 */
public interface KBaseUnit {

    /**
     * Return the name of the KnowledgeBase wrapped by this KBaseUnit
     * @return
     */
    String getKBaseName();

    /**
     * Lazily create and return the KnowledgeBase wrapped by this KBaseUnit
     * @return
     *     The KnowledgeBase
     */
    KnowledgeBase getKnowledgeBase();

    /**
     * If errors occurred during the build process they are added here
     * @return
     */
    boolean hasErrors();

    /**
     * Return the errors that occurred during the build process of the KnowledgeBase wrapped by this KBaseUnit
     * @return
     */
    KnowledgeBuilderErrors getErrors();

    /**
     * Instance a new StatefulKnowledgeSession identified by the gievn name from the KnowledgeBase wrapped by this KBaseUnit
     * @param kSessionName
     *     The name of the StatefulKnowledgeSession
     * @return
     *     The StatefulKnowledgeSession
     */
    StatefulKnowledgeSession newStatefulKnowledegSession(String ksessionName);

    /**
     * Instance a new StatelessKnowledgeSession identified by the gievn name from the KnowledgeBase wrapped by this KBaseUnit
     * @param kSessionName
     *     The name of the StatelessKnowledgeSession
     * @return
     *     The StatelessKnowledgeSession
     */
    StatelessKnowledgeSession newStatelessKnowledegSession(String ksessionName);
}