com.fluidbpm.program.api.vo.webkit.viewgroup.WebKitWorkspaceRouteField 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] - [2020] 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.webkit.viewgroup;

import com.fluidbpm.program.api.vo.ABaseFluidJSONObject;
import com.fluidbpm.program.api.vo.field.Field;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
import org.json.JSONObject;

import javax.xml.bind.annotation.XmlTransient;

/**
 * WebKit associated with job view group look and feels.
 *
 * @see Field
 */
@Getter
@Setter
@EqualsAndHashCode
public class WebKitWorkspaceRouteField extends ABaseFluidJSONObject {
	private Field routeField;

	private int fieldOrder;
	private String additionalFormatting;//FIXME [displayLabelAsBanner|fontWeight]

	@XmlTransient
	private boolean selected;

	/**
	 * The JSON mapping for the {@code WebKitForm} object.
	 */
	public static class JSONMapping {
		public static final String ROUTE_FIELD = "routeField";
		public static final String FIELD_ORDER = "fieldOrder";
	}

	public WebKitWorkspaceRouteField() {
		this(new JSONObject());
	}

	/**
	 * Populates local variables with {@code jsonObjectParam}.
	 *
	 * @param jsonObjectParam The JSON Object.
	 */
	public WebKitWorkspaceRouteField(JSONObject jsonObjectParam) {
		super(jsonObjectParam);
		if (this.jsonObject == null) {
			return;
		}

		if (!this.jsonObject.isNull(JSONMapping.ROUTE_FIELD)) {
			this.setRouteField(new Field(this.jsonObject.getJSONObject(JSONMapping.ROUTE_FIELD)));
		}

		if (!this.jsonObject.isNull(JSONMapping.FIELD_ORDER)) {
			this.setFieldOrder(this.jsonObject.getInt(JSONMapping.FIELD_ORDER));
		}
	}

	/**
	 * @param routeField The route field associated.
	 * @see Field
	 */
	public WebKitWorkspaceRouteField(Field routeField) {
		this();
		this.setRouteField(routeField);
	}

	/**
	 * Returns the local JSON object.
	 * Only set through constructor.
	 *
	 * @return The local set {@code JSONObject} object.
	 */
	@Override
	@XmlTransient
	public JSONObject toJsonObject() {
		JSONObject returnVal = super.toJsonObject();

		if (this.getRouteField() != null) {
			Field reducedField = new Field(this.getRouteField().getId());
			returnVal.put(JSONMapping.ROUTE_FIELD, reducedField.toJsonObject());
		}

		returnVal.put(JSONMapping.FIELD_ORDER, this.getFieldOrder());

		return returnVal;
	}

	/**
	 * Return the Text representation of {@code this} object.
	 *
	 * @return JSON body of {@code this} object.
	 */
	@Override
	@XmlTransient
	public String toString() {
		return super.toString();
	}

	/**
	 * Id for WebKit Field.
	 * @return Primary Key of {@code routeField}.
	 */
	@Override
	public Long getId() {
		return (this.routeField == null) ? null :
				this.routeField.getId();
	}
}