All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.kie.api.runtime.rule.Match Maven / Gradle / Ivy

/*
 * Copyright 2013 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.kie.api.runtime.rule;

import java.util.List;

import org.kie.api.definition.rule.Rule;

public interface Match {

    /**
     * @return rule that was activated.
     */
    Rule getRule();

    /**
     *
     * @return matched FactHandles for this Match
     */
    List< ? extends FactHandle> getFactHandles();

    /**
     * @return the list of objects that make the tuple that created
     * this Match. The objects are in the proper tuple order.
     */
    List getObjects();

    /**
     * @return the list of declaration identifiers that are bound to the
     * tuple that created this Match.
     */
    List getDeclarationIds();

    /**
     * @return the bound declaration value for the given declaration identifier.
     *
     * @param declarationId
     */
    Object getDeclarationValue(String declarationId);

}