com.fluidbpm.program.api.ICalculatedLabelField Maven / Gradle / Ivy

Go to download

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

Used for the * Custom Program Step, * Custom Actions, * Scheduled Actions and * Fluid API in the Fluid BPM and Content Management system.

There is a newer version: 1.12

Show newest version

/*
 * Koekiebox CONFIDENTIAL
 *
 * [2012] - [2017] Koekiebox (Pty) Ltd
 * All Rights Reserved.
 *
 * NOTICE: All information contained herein is, and remains the property
 * of Koekiebox and its suppliers, if any. The intellectual and
 * technical concepts contained herein are proprietary to Koekiebox
 * and its suppliers and may be covered by South African and Foreign Patents,
 * patents in process, and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material is strictly
 * forbidden unless prior written permission is obtained from Koekiebox.
 */

package com.fluidbpm.program.api;

import com.fluidbpm.program.api.vo.field.Field;
import com.fluidbpm.program.api.vo.form.Form;
import com.fluidbpm.program.api.vo.item.FluidItem;

/**
 * Implement this interface when you want Fluid populate a
 * label only field.
 * The value of the field will be calculated based on {@code Field}s of a {@code Form}.
 *
 * The fields are configured within Fluid.
 *
 * @author jasonbruwer
 * @since v1.8
 *
 * @see Form
 * @see Field
 *
 */
public interface ICalculatedLabelField extends IActionBase {

	/**
	 * Execute Order (2)
	 *
	 * The Fluid {@code Field} associated with the {@code sub-class} implementation.
	 * If there are conflicting field names, only the first will be executed.
	 *
	 * @return The Fluid Implementation Field Identifier.
	 */
	public abstract String getLabelFieldApplicable();

	/**
	 * Execute Order (3)
	 *
	 * @param fluidItemParam {@code FluidItem} that may be used to calculate the field label.
	 *
	 * @return The value of the field. String and primitive data types are supported.
	 * @throws Exception If any problems occur during execution.
	 *         The field with have a value of {@code -Error Retrieving Value-}
	 *
	 * @see FluidItem
	 * @see Field
	 */
	public abstract Object calculateFieldValue(FluidItem fluidItemParam) throws Exception;
}