com.fluidbpm.program.api.vo.flow.FlowStep 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 java.util.ArrayList;
import java.util.Date;
import java.util.List;

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

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

/**
 * Fluid workflow Step that belongs to a Flow.
 *
 * @author jasonbruwer
 * @since v1.0
 *
 * @see Flow
 * @see FlowStepRule
 * @see ABaseFluidJSONObject
 */
public class FlowStep extends ABaseFluidJSONObject {

	public static final long serialVersionUID = 1L;

	private String name;
	private String description;

	private Date dateCreated;
	private Date dateLastUpdated;

	//
	private Flow flow;
	private String flowStepType;

	private List entryRules;
	private List exitRules;
	private List viewRules;

	private List stepProperties;

	private Long flowStepParentId;

	/**
	 * The JSON mapping for the {@code FlowStep} object.
	 */
	public static class JSONMapping
	{
		public static final String NAME = "name";
		public static final String DESCRIPTION = "description";

		public static final String DATE_CREATED = "dateCreated";
		public static final String DATE_LAST_UPDATED = "dateLastUpdated";

		public static final String FLOW = "flow";
		public static final String FLOW_STEP_TYPE = "flowStepType";
		public static final String ENTRY_RULES = "entryRules";
		public static final String EXIT_RULES = "exitRules";
		public static final String VIEW_RULES = "viewRules";
		public static final String STEP_PROPERTIES = "stepProperties";

		public static final String FLOW_STEP_PARENT_ID = "flowStepParentId";
	}

	/**
	 * The Type of Step to create or update.
	 */
	public static class StepType {
		public static final String INTRODUCTION = "Introduction";
		public static final String RE_ROUTE = "Re Route";
		public static final String EXIT = "Exit";
		public static final String ASSIGNMENT = "Assignment";
		public static final String MAIL_CAPTURE = "Mail Capture";
		public static final String DATABASE_CAPTURE = "Database Capture";
		public static final String SEND_MAIL = "Send Mail";
		public static final String POLLING = "Polling";
		public static final String JAVA_PROGRAM = "Java Program";
		public static final String CLONE_ITEM = "Clone Item";
	}

	/**
	 * Additional properties applicable to specific FlowStep types.
	 */
	public static class StepProperty extends ABaseFluidJSONObject
	{
		private String name;
		private String value;

		/**
		 * A list of the available properties to set.
		 */
		public static class PropName
		{
			//Assignment Step...
			public static final String ItemTimeoutDays = "ItemTimeoutDays";
			public static final String ItemTimeoutHours = "ItemTimeoutHours";
			public static final String ItemTimeoutMinutes = "ItemTimeoutMinutes";

			public static final String UserItemTimeoutDays = "UserItemTimeoutDays";
			public static final String UserItemTimeoutHours = "UserItemTimeoutHours";
			public static final String UserItemTimeoutMinutes = "UserItemTimeoutMinutes";

			public static final String PerformMeasureExpectedDailyAbsurd = "PerformMeasureExpectedDailyAbsurd";
			public static final String PerformMeasureExpectedDailyHigh = "PerformMeasureExpectedDailyHigh";
			public static final String PerformMeasureExpectedDailyLow = "PerformMeasureExpectedDailyLow";

			public static final String RouteFields = "RouteFields";
			public static final String ViewGroup = "ViewGroup";
			public static final String ViewGroupPriority = "ViewGroupPriority";

			//Send Mail...
			public static final String MailTemplateDescription = "MailTemplateDescription";
			public static final String MailTemplateSubject = "MailTemplateSubject";
			public static final String MailTemplateBodyType = "MailTemplateBodyType";
			public static final String MailTemplateBodyContent = "MailTemplateBodyContent";
			public static final String IncludeAttachments = "IncludeAttachments";
			public static final String RecipientSyntax = "RecipientSyntax";

			//Polling...
			public static final String PollingType = "PollingType";

			//Java Program...
			public static final String TaskIdentifier = "TaskIdentifier";
			public static final String ProgramNameValueProperties = "ProgramNameValueProperties";

			//Clone Item...
			public static final String CloneAttachments = "CloneAttachments";
			public static final String SendCloneTo = "SendCloneTo";
			public static final String DestinationForm = "DestinationForm";
		}

		/**
		 * The JSON mapping for the {@code StepProperty} object.
		 */
		public static class JSONMapping
		{
			public static final String NAME = "name";
			public static final String VALUE = "value";
		}

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

		/**
		 * Sets a step property name and value.
		 *
		 * @param nameParam The property name.
		 * @param valueParam The property value.
		 */
		public StepProperty(String nameParam, String valueParam) {

			this.setName(nameParam);
			this.setValue(valueParam);
		}

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

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

			//Name...
			if (!this.jsonObject.isNull(JSONMapping.NAME)) {
				this.setName(this.jsonObject.getString(JSONMapping.NAME));
			}

			//Value...
			if (!this.jsonObject.isNull(JSONMapping.VALUE)) {
				this.setValue(this.jsonObject.getString(JSONMapping.VALUE));
			}
		}

		/**
		 * Name of the Step property.
		 *
		 * @return Step Property Name.
		 */
		public String getName() {
			return this.name;
		}

		/**
		 * Name of the Step property.
		 *
		 * @param nameParam Step Property Name.
		 */
		public void setName(String nameParam) {
			this.name = nameParam;
		}

		/**
		 * Value of the Step property.
		 *
		 * @return Step Property Value.
		 */
		public String getValue() {
			return this.value;
		}

		/**
		 * Value of the Step property.
		 *
		 * @param valueParam Step Property Value.
		 */
		public void setValue(String valueParam) {
			this.value = valueParam;
		}

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

			//Name...
			if (this.getName() != null)
			{
				returnVal.put(JSONMapping.NAME, this.getName());
			}

			//Value...
			if (this.getValue() != null)
			{
				returnVal.put(JSONMapping.VALUE, this.getValue());
			}

			return returnVal;
		}
	}

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

	/**
	 * Unique identifier of the Flow Step.
	 *
	 * @param flowStepIdParam Flow Step Primary key.
	 */
	public FlowStep(Long flowStepIdParam) {
		super();

		this.setId(flowStepIdParam);
	}

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

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

		//Name...
		if (!this.jsonObject.isNull(JSONMapping.NAME)) {
			this.setName(this.jsonObject.getString(JSONMapping.NAME));
		}

		//Description...
		if (!this.jsonObject.isNull(JSONMapping.DESCRIPTION)) {
			this.setDescription(this.jsonObject.getString(JSONMapping.DESCRIPTION));
		}

		//Date Created...
		this.setDateCreated(this.getDateFieldValueFromFieldWithName(
				JSONMapping.DATE_CREATED));

		//Date Last Updated...
		this.setDateLastUpdated(this.getDateFieldValueFromFieldWithName(
				JSONMapping.DATE_LAST_UPDATED));

		//Flow...
		if (!this.jsonObject.isNull(JSONMapping.FLOW)) {
			this.setFlow(new Flow(this.jsonObject.getJSONObject(JSONMapping.FLOW)));
		}

		//Flow Step Type...
		if (!this.jsonObject.isNull(JSONMapping.FLOW_STEP_TYPE)) {
			this.setFlowStepType(this.jsonObject.getString(JSONMapping.FLOW_STEP_TYPE));
		}

		//Flow Step Parent Id...
		if (!this.jsonObject.isNull(JSONMapping.FLOW_STEP_PARENT_ID)) {

			this.setFlowStepParentId(this.jsonObject.getLong(
					JSONMapping.FLOW_STEP_PARENT_ID));
		}

		//Entry Rules...
		if (!this.jsonObject.isNull(JSONMapping.ENTRY_RULES)) {

			JSONArray entryRules = this.jsonObject.getJSONArray(JSONMapping.ENTRY_RULES);

			List listOfRules = new ArrayList();
			for (int index = 0;index < entryRules.length();index++)
			{
				listOfRules.add(new FlowStepRule(entryRules.getJSONObject(index)));
			}

			this.setEntryRules(listOfRules);
		}

		//Exit Rules...
		if (!this.jsonObject.isNull(JSONMapping.EXIT_RULES)) {

			JSONArray exitRules = this.jsonObject.getJSONArray(JSONMapping.EXIT_RULES);

			List listOfRules = new ArrayList();
			for (int index = 0;index < exitRules.length();index++)
			{
				listOfRules.add(new FlowStepRule(exitRules.getJSONObject(index)));
			}

			this.setExitRules(listOfRules);
		}

		//View Rules...
		if (!this.jsonObject.isNull(JSONMapping.VIEW_RULES)) {

			JSONArray viewRules = this.jsonObject.getJSONArray(JSONMapping.VIEW_RULES);

			List listOfRules = new ArrayList();
			for (int index = 0;index < viewRules.length();index++)
			{
				listOfRules.add(new FlowStepRule(viewRules.getJSONObject(index)));
			}

			this.setViewRules(listOfRules);
		}

		//Step Properties...
		if (!this.jsonObject.isNull(JSONMapping.STEP_PROPERTIES)) {
			JSONArray stepProperties = this.jsonObject.getJSONArray(JSONMapping.STEP_PROPERTIES);

			List listOfStepProps = new ArrayList();
			for (int index = 0;index < stepProperties.length();index++)
			{
				listOfStepProps.add(new StepProperty(stepProperties.getJSONObject(index)));
			}

			this.setStepProperties(listOfStepProps);
		}
	}

	/**
	 * Sets the property value of the step with
	 * property name {@code nameParam}.
	 *
	 * @param nameParam The property name.
	 * @param valueParam The property value.
	 */
	public void setStepProperty(
			String nameParam, String valueParam)
	{
		if (this.getStepProperties() == null)
		{
			this.setStepProperties(new ArrayList());
		}

		if (nameParam == null || nameParam.trim().isEmpty())
		{
			return;
		}

		if (valueParam.trim().isEmpty())
		{
			return;
		}

		String paramLower = nameParam.toLowerCase();

		for (StepProperty existingProp : this.getStepProperties())
		{
			if (existingProp.getName().toLowerCase().equals(paramLower))
			{
				existingProp.setValue(valueParam);
				return;
			}
		}

		this.getStepProperties().add(new StepProperty(nameParam, valueParam));
	}

	/**
	 * Gets the step property with name {@code nameParam}
	 *
	 * @param nameParam The property to retrieve.
	 * @return Value of the property with name {@code nameParam}.
	 */
	public String getStepProperty(String nameParam)
	{
		if (this.getStepProperties() == null || this.getStepProperties().isEmpty())
		{
			return null;
		}

		if (nameParam == null || nameParam.trim().isEmpty())
		{
			return null;
		}

		String paramLower = nameParam.toLowerCase();

		for (StepProperty stepProperty : this.getStepProperties())
		{
			if (stepProperty.getName().toLowerCase().equals(paramLower))
			{
				return stepProperty.getValue();
			}
		}

		return null;
	}

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

		//Name...
		if (this.getName() != null)
		{
			returnVal.put(JSONMapping.NAME,this.getName());
		}

		//Description...
		if (this.getDescription() != null)
		{
			returnVal.put(JSONMapping.DESCRIPTION,this.getDescription());
		}

		//Date Created...
		if (this.getDateCreated() != null)
		{
			returnVal.put(JSONMapping.DATE_CREATED,
					this.getDateAsLongFromJson(this.getDateCreated()));
		}

		//Date Last Updated...
		if (this.getDateLastUpdated() != null)
		{
			returnVal.put(JSONMapping.DATE_LAST_UPDATED,
					this.getDateAsLongFromJson(this.getDateLastUpdated()));
		}

		//Flow...
		if (this.getFlow() != null)
		{
			returnVal.put(JSONMapping.FLOW,
					this.getFlow().toJsonObject());
		}

		//Flow Step Type...
		if (this.getFlowStepType() != null)
		{
			returnVal.put(JSONMapping.FLOW_STEP_TYPE,this.getFlowStepType());
		}

		//Flow Step Parent Id...
		if (this.getFlowStepParentId() != null)
		{
			returnVal.put(
					JSONMapping.FLOW_STEP_PARENT_ID, this.getFlowStepParentId());
		}

		//Entry Rules...
		if (this.getEntryRules() != null && !this.getEntryRules().isEmpty())
		{
			JSONArray jsonArray = new JSONArray();

			for (FlowStepRule rule : this.getEntryRules())
			{
				jsonArray.put(rule.toJsonObject());
			}

			returnVal.put(JSONMapping.ENTRY_RULES, jsonArray);
		}

		//Exit Rules...
		if (this.getExitRules() != null && !this.getExitRules().isEmpty())
		{
			JSONArray jsonArray = new JSONArray();

			for (FlowStepRule rule : this.getExitRules())
			{
				jsonArray.put(rule.toJsonObject());
			}

			returnVal.put(JSONMapping.EXIT_RULES, jsonArray);
		}

		//View Rules...
		if (this.getViewRules() != null && !this.getViewRules().isEmpty())
		{
			JSONArray jsonArray = new JSONArray();

			for (FlowStepRule rule : this.getViewRules())
			{
				jsonArray.put(rule.toJsonObject());
			}

			returnVal.put(JSONMapping.VIEW_RULES, jsonArray);
		}

		//Step Properties...
		if (this.getStepProperties() != null && !this.getStepProperties().isEmpty())
		{
			JSONArray jsonArray = new JSONArray();

			for (StepProperty stepProperty : this.getStepProperties())
			{
				jsonArray.put(stepProperty.toJsonObject());
			}

			returnVal.put(JSONMapping.STEP_PROPERTIES, jsonArray);
		}

		return returnVal;
	}

	/**
	 * Gets Name of the step.
	 *
	 * @return Step name.
	 */
	public String getName() {
		return this.name;
	}

	/**
	 * Sets Name of the step.
	 *
	 * @param nameParam Step name.
	 */
	public void setName(String nameParam) {
		this.name = nameParam;
	}

	/**
	 * Gets Description of the step.
	 *
	 * @return Step description.
	 */
	public String getDescription() {
		return this.description;
	}

	/**
	 * Sets Description of the step.
	 *
	 * @param descriptionParam Step description.
	 */
	public void setDescription(String descriptionParam) {
		this.description = descriptionParam;
	}

	/**
	 * Gets the  date Step was created.
	 *
	 * @return Step Creation Timestamp.
	 *
	 * @see Date
	 */
	public Date getDateCreated() {
		return this.dateCreated;
	}

	/**
	 * Sets the date Step was created.
	 *
	 * @param dateCreatedParam Step Creation Timestamp.
	 *
	 * @see Date
	 */
	public void setDateCreated(Date dateCreatedParam) {
		this.dateCreated = dateCreatedParam;
	}

	/**
	 * Gets the date Step was last updated.
	 *
	 * @return Step last Update Timestamp.
	 *
	 * @see Date
	 */
	public Date getDateLastUpdated() {
		return this.dateLastUpdated;
	}

	/**
	 * Sets the date Step was last updated.
	 *
	 * @param dateLastUpdatedParam Step last Update Timestamp.
	 *
	 * @see Date
	 */
	public void setDateLastUpdated(Date dateLastUpdatedParam) {
		this.dateLastUpdated = dateLastUpdatedParam;
	}

	/**
	 * Gets the Flow associated with the step.
	 *
	 * @return Flow for the Step.
	 */
	public Flow getFlow() {
		return this.flow;
	}

	/**
	 * Sets the Flow associated with the step.
	 *
	 * @param flowParam Flow for the Step.
	 */
	public void setFlow(Flow flowParam) {
		this.flow = flowParam;
	}

	/**
	 * Gets the type of Step.
	 *
	 * @return Text version of Flow Step type.
	 *
	 * @see StepType
	 */
	public String getFlowStepType() {
		return this.flowStepType;
	}

	/**
	 * Sets the type of Step.
	 *
	 * @param flowStepTypeParam Text version of Flow Step type.
	 *
	 * @see StepType
	 */
	public void setFlowStepType(String flowStepTypeParam) {
		this.flowStepType = flowStepTypeParam;
	}

	/**
	 * Gets the Flow Step parent id with {@code this} Step.
	 *
	 * The parent id is the containing Step primary key.
	 *
	 * Example would be the primary key for an {@code AssignmentStep}.
	 *
	 * @return Parent Id for {@code this} Step.
	 */
	public Long getFlowStepParentId() {
		return this.flowStepParentId;
	}

	/**
	 * Gets the Flow Step parent id with {@code this} Step.
	 *
	 * The parent id is the containing Step primary key.
	 *
	 * Example would be the primary key for an {@code AssignmentStep}.
	 *
	 * @param flowStepParentIdParam Parent Id for {@code this} Step.
	 */
	public void setFlowStepParentId(Long flowStepParentIdParam) {
		this.flowStepParentId = flowStepParentIdParam;
	}

	/**
	 * Gets the Entry Rules associated with {@code this} Step.
	 *
	 * @return Entry rules for {@code this} Step.
	 */
	public List getEntryRules() {
		return this.entryRules;
	}

	/**
	 * Sets the Entry Rules associated with {@code this} Step.
	 *
	 * @param entryRulesParam Entry rules for {@code this} Step.
	 */
	public void setEntryRules(List entryRulesParam) {
		this.entryRules = entryRulesParam;
	}

	/**
	 * Gets the Exit Rules associated with {@code this} Step.
	 *
	 * @return Exit rules for {@code this} Step.
	 */
	public List getExitRules() {
		return this.exitRules;
	}

	/**
	 * Sets the Exit Rules associated with {@code this} Step.
	 *
	 * @param exitRulesParam Exit rules for {@code this} Step.
	 */
	public void setExitRules(List exitRulesParam) {
		this.exitRules = exitRulesParam;
	}

	/**
	 * Gets the View Rules associated with {@code this} Step.
	 *
	 * @return View rules for {@code this} Step.
	 */
	public List getViewRules() {
		return this.viewRules;
	}

	/**
	 * Sets the View Rules associated with {@code this} Step.
	 *
	 * @param viewRulesParam View rules for {@code this} Step.
	 */
	public void setViewRules(List viewRulesParam) {
		this.viewRules = viewRulesParam;
	}

	/**
	 * Gets the Step Properties.
	 *
	 * @return Step Properties.
	 *
	 * @see StepProperty
	 */
	public List getStepProperties() {
		return this.stepProperties;
	}

	/**
	 * Sets the Step Properties.
	 *
	 * @param stepPropertiesParam Step Properties.
	 *
	 * @see StepProperty
	 */
	public void setStepProperties(List stepPropertiesParam) {
		this.stepProperties = stepPropertiesParam;
	}
}