com.fluidbpm.program.api.vo.flow.FlowItemExecutePacket 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.vo.flow;

import org.json.JSONException;
import org.json.JSONObject;

import com.fluidbpm.program.api.vo.ABaseFluidJSONObject;
import com.fluidbpm.program.api.vo.item.FluidItem;

/**
 * 
 *     Container POJO used to contain
 *     the {@code FluidItem} and {@code FlowStepRule}.
 *
 * 
 *     Purely used to {@code compile} and {@code execute} a
 *     Fluid Rule against a {@code FluidItem} in realtime.
 *
 * @author jasonbruwer
 * @since v1.0
 * @see FluidItem
 * @see FlowStepRule
 */
public class FlowItemExecutePacket extends ABaseFluidJSONObject {

	public static final long serialVersionUID = 1L;

	private FlowStepRule flowStepRule;
	private FluidItem fluidItem;

	/**
	 * The JSON mapping for the {@code FlowItemExecutePacket} object.
	 */
	public static class JSONMapping
	{
		public static final String FLOW_STEP_RULE = "flowStepRule";
		public static final String FLUID_ITEM = "fluidItem";
	}

	/**
	 * Default constructor.
	 */
	public FlowItemExecutePacket() {
		super();
	}

	/**
	 * Populates local variables with {@code jsonObjectParam}.
	 *
	 * @param jsonObjectParam The JSON Object.
	 */
	public FlowItemExecutePacket(JSONObject jsonObjectParam) {
		super(jsonObjectParam);

		if (this.jsonObject == null)
		{
			return;
		}

		//Fluid Item...
		if (!this.jsonObject.isNull(JSONMapping.FLOW_STEP_RULE)) {

			this.setFluidItem(new FluidItem(this.jsonObject.getJSONObject(
					JSONMapping.FLUID_ITEM)));
		}

		//Flow Step Rule...
		if (!this.jsonObject.isNull(JSONMapping.FLOW_STEP_RULE)) {

			this.setFlowStepRule(new FlowStepRule(
					this.jsonObject.getJSONObject(JSONMapping.FLOW_STEP_RULE)));
		}
	}

	/**
	 * Conversion to {@code JSONObject} from Java Object.
	 *
	 * @return {@code JSONObject} representation of {@code FlowItemExecutePacket}
	 * @throws JSONException If there is a problem with the JSON Body.
	 *
	 * @see ABaseFluidJSONObject#toJsonObject()
	 */
	@Override
	public JSONObject toJsonObject() throws JSONException
	{
		JSONObject returnVal = super.toJsonObject();

		//Fluid Item...
		if (this.getFluidItem() != null)
		{
			returnVal.put(JSONMapping.FLUID_ITEM,
					this.getFluidItem().toJsonObject());
		}

		//Flow Step Rule...
		if (this.getFlowStepRule() != null)
		{
			returnVal.put(JSONMapping.FLOW_STEP_RULE,
					this.getFlowStepRule().toJsonObject());
		}

		return returnVal;
	}

	/**
	 * Gets the rule to execute.
	 *
	 * @return Rule to execute.
	 *
	 * @see FlowStepRule
	 */
	public FlowStepRule getFlowStepRule() {
		return this.flowStepRule;
	}

	/**
	 * Sets the rule to execute.
	 *
	 * @param flowStepRuleParam Rule to execute.
	 *
	 * @see FlowStepRule
	 */
	public void setFlowStepRule(FlowStepRule flowStepRuleParam) {
		this.flowStepRule = flowStepRuleParam;
	}

	/**
	 * Gets the Fluid item.
	 *
	 * @return Fluid item.
	 *
	 * @see FluidItem
	 */
	public FluidItem getFluidItem() {
		return this.fluidItem;
	}

	/**
	 * Sets the Fluid item.
	 *
	 * @param fluidItemParam Fluid item.
	 *
	 * @see FluidItem
	 */
	public void setFluidItem(FluidItem fluidItemParam) {
		this.fluidItem = fluidItemParam;
	}
}