All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.fluidbpm.ws.client.v1.form.FormFieldClient Maven / Gradle / Ivy

    /*
 * 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.ws.client.v1.form;

import com.fluidbpm.program.api.util.UtilGlobal;
import com.fluidbpm.program.api.vo.field.Field;
import com.fluidbpm.program.api.vo.field.MultiChoice;
import com.fluidbpm.program.api.vo.form.Form;
import com.fluidbpm.program.api.vo.form.FormFieldListing;
import com.fluidbpm.program.api.vo.form.FormListing;
import com.fluidbpm.program.api.vo.userquery.UserQuery;
import com.fluidbpm.program.api.vo.userquery.UserQueryListing;
import com.fluidbpm.program.api.vo.ws.WS;
import com.fluidbpm.ws.client.FluidClientException;
import com.fluidbpm.ws.client.v1.ABaseFieldClient;
import org.json.JSONObject;

import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;

/**
 * Java Web Service Client for Form Field related actions.
 *
 * @author jasonbruwer
 * @since v1.0
 *
 * @see JSONObject
 * @see com.fluidbpm.program.api.vo.ws.WS.Path.FormField
 * @see Field
 */
public class FormFieldClient extends ABaseFieldClient {

	/**
	 * Creates a new client and sets the Base Endpoint URL.
	 *
	 * @param endpointBaseUrlParam URL to base endpoint.
	 * @param serviceTicketParam The Server issued Service Ticket.
	 * @param requestUuidParam The unique identifier per request.
	 */
	public FormFieldClient(
		String endpointBaseUrlParam,
		String serviceTicketParam,
		String requestUuidParam
	) {
		super(endpointBaseUrlParam, serviceTicketParam, requestUuidParam);
	}

	/**
	 * Creates a new client and sets the Base Endpoint URL.
	 *
	 * @param endpointBaseUrlParam URL to base endpoint.
	 * @param serviceTicketParam The Server issued Service Ticket.
	 */
	public FormFieldClient(
		String endpointBaseUrlParam,
		String serviceTicketParam
	) {
		super(endpointBaseUrlParam, serviceTicketParam);
	}

	/**
	 * Create the field based on the {@code Field#getTypeAsEnum} and {@code Field#getTypeMetaData}.
	 *
	 * @param formField Field to Create.
	 * @param additionalInfo The meta-data additional info used for creation.
	 * @return Created Field.
	 *
	 * @throws FluidClientException If there are validation failures.
	 * @see FluidClientException.ErrorCode#FIELD_VALIDATE
	 */
	public Field createField(Field formField, Object ... additionalInfo) {
		if (formField.getTypeAsEnum() == null || formField.getTypeMetaData() == null) {
			throw new FluidClientException(
					String.format("Field type and meta-data is mandatory. See '%s'.", formField.getFieldName()),
					FluidClientException.ErrorCode.FIELD_VALIDATE);
		}

		String metaData = formField.getTypeMetaData();
		String metaDataLower = metaData.toLowerCase();
		switch (formField.getTypeAsEnum()) {
			case Text:
				if (FieldMetaData.Text.PLAIN.toLowerCase().equals(metaDataLower)) {
					return this.createFieldTextPlain(formField);
				} else if (metaDataLower.contains(FieldMetaData.Text.MASKED.toLowerCase())) {
					if (additionalInfo == null || additionalInfo.length < 1)
						throw new FluidClientException(
								String.format("No additional info for '%s' field '%s'.",
										FieldMetaData.Text.MASKED, formField.getFieldName()),
								FluidClientException.ErrorCode.FIELD_VALIDATE);
					return this.createFieldTextMasked(formField, additionalInfo[0].toString());
				} else if (metaDataLower.contains(FieldMetaData.Text.BARCODE.toLowerCase())) {
					if (additionalInfo == null || additionalInfo.length < 1)
						throw new FluidClientException(
								String.format("No additional info for '%s' field '%s'.",
										FieldMetaData.Text.BARCODE, formField.getFieldName()),
								FluidClientException.ErrorCode.FIELD_VALIDATE);
					return this.createFieldTextBarcode(formField, additionalInfo[0].toString());
				} else if (metaDataLower.contains(FieldMetaData.Text.LATITUDE_AND_LONGITUDE.toLowerCase())) {
					return this.createFieldTextLatitudeAndLongitude(formField);
				}
				throw new FluidClientException(
						String.format("Unable to determine '%s' type for meta-data '%s'.",
								formField.getTypeAsEnum(),
								metaData), FluidClientException.ErrorCode.FIELD_VALIDATE);
			case TextEncrypted:
				if (FieldMetaData.EncryptedText.PLAIN.toLowerCase().equals(metaDataLower)) {
					return this.createFieldTextEncryptedPlain(formField);
				} else if (metaDataLower.contains(FieldMetaData.EncryptedText.MASKED.toLowerCase())) {
					return this.createFieldTextEncryptedMasked(formField, additionalInfo[0].toString());
				}
				throw new FluidClientException(
						String.format("Unable to determine '%s' type for meta-data '%s'.",
								formField.getTypeAsEnum(),
								metaData), FluidClientException.ErrorCode.FIELD_VALIDATE);
			case TrueFalse:
				return this.createFieldTrueFalse(formField);
			case DateTime:
				if (FieldMetaData.DateTime.DATE.toLowerCase().equals(metaDataLower)) {
					return this.createFieldDateTimeDate(formField);
				} else if (FieldMetaData.DateTime.DATE_AND_TIME.toLowerCase().equals(metaDataLower)) {
					return this.createFieldDateTimeDateAndTime(formField);
				}
				throw new FluidClientException(
						String.format("Unable to determine '%s' type for meta-data '%s'.",
								formField.getTypeAsEnum(),
								metaData), FluidClientException.ErrorCode.FIELD_VALIDATE);
			case Decimal:
				if (FieldMetaData.Decimal.PLAIN.toLowerCase().equals(metaDataLower)) {
					return this.createFieldDecimalPlain(formField);
				} else if (metaDataLower.contains(FieldMetaData.Decimal.RATING.toLowerCase())) {
					return this.createFieldDecimalRating(
							formField, (Double)additionalInfo[0], (Double)additionalInfo[1]);
				} else if (metaDataLower.contains(FieldMetaData.Decimal.SLIDER.toLowerCase())) {
					return this.createFieldDecimalSlider(
							formField,
							(Double)additionalInfo[0],
							(Double)additionalInfo[1],
							(Double)additionalInfo[2]);
				} else if (metaDataLower.contains(FieldMetaData.Decimal.SPINNER.toLowerCase())) {
					return this.createFieldDecimalSpinner(
							formField,
							(Double)additionalInfo[0],
							(Double)additionalInfo[1],
							(Double)additionalInfo[2],
							additionalInfo[3].toString());
				}
				throw new FluidClientException(
						String.format("Unable to determine '%s' type for meta-data '%s'.", formField.getTypeAsEnum(), metaData),
						FluidClientException.ErrorCode.FIELD_VALIDATE);
			case MultipleChoice:
				if (FieldMetaData.MultiChoice.PLAIN.toLowerCase().equals(metaDataLower)) {
					return this.createFieldMultiChoicePlain(formField, (List)additionalInfo[0]);
				} else if (FieldMetaData.MultiChoice.PLAIN_SEARCH.toLowerCase().equals(metaDataLower)) {
					return this.createFieldMultiChoicePlainWithSearch(formField, (List)additionalInfo[0]);
				} else if (FieldMetaData.MultiChoice.SELECT_MANY.toLowerCase().equals(metaDataLower)) {
					return this.createFieldMultiChoiceSelectMany(formField, (List)additionalInfo[0]);
				} else if (FieldMetaData.MultiChoice.SELECT_MANY_SEARCH.toLowerCase().equals(metaDataLower)) {
					return this.createFieldMultiChoiceSelectManyWithSearch(formField, (List)additionalInfo[0]);
				}
				throw new FluidClientException(
						String.format("Unable to determine '%s' type for meta-data '%s'.", formField.getTypeAsEnum(), metaData),
						FluidClientException.ErrorCode.FIELD_VALIDATE);
			case ParagraphText:
				if (FieldMetaData.ParagraphText.PLAIN.toLowerCase().equals(metaDataLower)) {
					return this.createFieldParagraphTextPlain(formField);
				} else if (FieldMetaData.ParagraphText.HTML.toLowerCase().equals(metaDataLower)) {
					return this.createFieldParagraphTextHTML(formField);
				} else if (FieldMetaData.ParagraphText.SIGNATURE.toLowerCase().equals(metaDataLower)) {
					return this.createFieldParagraphTextSignature(formField);
				}
				throw new FluidClientException(
						String.format("Unable to determine '%s' type for meta-data '%s'.", formField.getTypeAsEnum(), metaData),
						FluidClientException.ErrorCode.FIELD_VALIDATE);
			case Table:
				return this.createFieldTable(formField, (Form)additionalInfo[0], (Boolean)additionalInfo[1]);
			case Label:
				if (FieldMetaData.Label.PLAIN.toLowerCase().equals(metaDataLower)) {
					return this.createFieldLabelPlain(formField);
				} else if (FieldMetaData.Label.MAKE_PAYMENT.toLowerCase().equals(metaDataLower)) {
					return this.createFieldLabelMakePayment(formField);
				} else if (FieldMetaData.Label.CUSTOM_WEB_ACTION.toLowerCase().equals(metaDataLower)) {
					return this.createFieldLabelCustomWebAction(formField);
				} else if (FieldMetaData.Label.ANCHOR.toLowerCase().equals(metaDataLower)) {
					return this.createFieldLabelAnchor(formField, (String)additionalInfo[0]);
				}
				throw new FluidClientException(
						String.format("Unable to determine '%s' type for meta-data '%s'.", formField.getTypeAsEnum(), metaData),
						FluidClientException.ErrorCode.FIELD_VALIDATE);
			default:
				throw new FluidClientException(
						String.format("Unable to determine type for '%s'.", formField.getTypeAsEnum()),
						FluidClientException.ErrorCode.FIELD_VALIDATE);
		}
	}

	/**
	 * Create a new Plain Text field.
	 *
	 * @param formFieldParam Field to Create.
	 * @return Created Field.
	 */
	public Field createFieldTextPlain(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) formFieldParam.setServiceTicket(this.serviceTicket);

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Text);
			formFieldParam.setTypeMetaData(FieldMetaData.Text.PLAIN);
		}

		return new Field(this.putJson(formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Plain Encrypted Text field.
	 *
	 * @param formFieldParam Field to Create.
	 * @return Created Field.
	 */
	public Field createFieldTextEncryptedPlain(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) formFieldParam.setServiceTicket(this.serviceTicket);

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.TextEncrypted);
			formFieldParam.setTypeMetaData(FieldMetaData.EncryptedText.PLAIN);
		}
		return new Field(this.putJson(formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Masked Encrypted Text field.
	 *
	 * @param formFieldParam Field to Create.
	 * @param maskedValue The mask value for the encrypted field.
	 * @return Created Field.
	 */
	public Field createFieldTextEncryptedMasked(Field formFieldParam, String maskedValue) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.TextEncrypted);
			formFieldParam.setTypeMetaData(FieldMetaData.EncryptedText.MASKED.concat(
					maskedValue == null ? UtilGlobal.EMPTY : maskedValue));
		}
		return new Field(this.putJson(formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Text Masked field.
	 *
	 * @param formFieldParam Field to Create.
	 * @param maskValueParam The masked value. Example: (999) 999 xxx.
	 * @return Created Field.
	 */
	public Field createFieldTextMasked(
		Field formFieldParam,
		String maskValueParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (maskValueParam == null || maskValueParam.trim().isEmpty()) {
			maskValueParam = "";
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Text);
			formFieldParam.setTypeMetaData(FieldMetaData.Text.MASKED.concat(maskValueParam));
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Text Barcode field.
	 *
	 * @param formFieldParam Field to Create.
	 * @param barcodeTypeParam The type of barcode.
	 * @return Created Field.
	 *
	 * @see com.fluidbpm.ws.client.v1.ABaseFieldClient.FieldMetaData.Text
	 */
	public Field createFieldTextBarcode(
		Field formFieldParam,
		String barcodeTypeParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) formFieldParam.setServiceTicket(this.serviceTicket);

		if (barcodeTypeParam == null || barcodeTypeParam.trim().isEmpty()) {
			throw new FluidClientException("Barcode type cannot be empty.", FluidClientException.ErrorCode.FIELD_VALIDATE);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Text);
			formFieldParam.setTypeMetaData(FieldMetaData.Text.BARCODE.concat(barcodeTypeParam));
		}

		return new Field(this.putJson(formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Text field with latitude and longitude.
	 *
	 * @param formFieldParam Field to Create.
	 * @return Created Field.
	 */
	public Field createFieldTextLatitudeAndLongitude(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) formFieldParam.setServiceTicket(this.serviceTicket);

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Text);
			formFieldParam.setTypeMetaData(FieldMetaData.Text.LATITUDE_AND_LONGITUDE);
		}
		return new Field(this.putJson(formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Label Plain field.
	 *
	 * @param formFieldParam Field to Create.
	 * @return Created Field.
	 *
	 * @see com.fluidbpm.ws.client.v1.ABaseFieldClient.FieldMetaData.Label
	 */
	public Field createFieldLabelPlain(
		Field formFieldParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) formFieldParam.setServiceTicket(this.serviceTicket);
		
		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Label);
			formFieldParam.setTypeMetaData(FieldMetaData.Label.PLAIN);
		}

		return new Field(this.putJson(formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Label MakePayment field.
	 *
	 * @param formFieldParam Field to Create.
	 * @return Created Field.
	 *
	 * @see com.fluidbpm.ws.client.v1.ABaseFieldClient.FieldMetaData.Label
	 */
	public Field createFieldLabelMakePayment(
		Field formFieldParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) formFieldParam.setServiceTicket(this.serviceTicket);

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Label);
			formFieldParam.setTypeMetaData(FieldMetaData.Label.MAKE_PAYMENT);
		}

		return new Field(this.putJson(formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Label CustomWebAction field.
	 *
	 * @param formFieldParam Field to Create.
	 * @return Created Field.
	 *
	 * @see com.fluidbpm.ws.client.v1.ABaseFieldClient.FieldMetaData.Label
	 */
	public Field createFieldLabelCustomWebAction(
			Field formFieldParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) formFieldParam.setServiceTicket(this.serviceTicket);

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Label);
			formFieldParam.setTypeMetaData(FieldMetaData.Label.CUSTOM_WEB_ACTION);
		}

		return new Field(this.putJson(formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Label Anchor field.
	 *
	 * @param formFieldParam Field to Create.
	 * @param anchorValue The anchor value.
	 * @return Created Field.
	 *
	 * @see com.fluidbpm.ws.client.v1.ABaseFieldClient.FieldMetaData.Label
	 */
	public Field createFieldLabelAnchor(
		Field formFieldParam,
		String anchorValue
	) {
		if (formFieldParam != null && this.serviceTicket != null) formFieldParam.setServiceTicket(this.serviceTicket);

		if (anchorValue == null || anchorValue.trim().isEmpty()) {
			throw new FluidClientException("Anchor cannot be empty.", FluidClientException.ErrorCode.FIELD_VALIDATE);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Label);
			formFieldParam.setTypeMetaData(String.format("%s_%s", FieldMetaData.Label.ANCHOR, anchorValue));
		}

		return new Field(this.putJson(formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new True False field.
	 *
	 * @param formFieldParam Field to Create.
	 * @return Created Field.
	 */
	public Field createFieldTrueFalse(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.TrueFalse);
			formFieldParam.setTypeMetaData(FieldMetaData.TrueFalse.TRUE_FALSE);
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Paragraph Text field.
	 *
	 * @param formFieldParam Field to Create.
	 * @return Created Field.
	 */
	public Field createFieldParagraphTextPlain(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.ParagraphText);
			formFieldParam.setTypeMetaData(FieldMetaData.ParagraphText.PLAIN);
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Paragraph HTML field.
	 *
	 * @param formFieldParam Field to Create.
	 * @return Created Field.
	 */
	public Field createFieldParagraphTextHTML(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.ParagraphText);
			formFieldParam.setTypeMetaData(FieldMetaData.ParagraphText.HTML);
		}

		return new Field(this.putJson(formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Paragraph Signature field.
	 *
	 * @param formFieldParam Field to Create.
	 * @return Created Field.
	 */
	public Field createFieldParagraphTextSignature(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.ParagraphText);
			formFieldParam.setTypeMetaData(FieldMetaData.ParagraphText.SIGNATURE);
		}

		return new Field(this.putJson(formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Multi Choice field.
	 *
	 * @param formFieldParam Field to Create.
	 * @param multiChoiceValuesParam The available multi choice values.
	 * @return Created Field.
	 */
	public Field createFieldMultiChoicePlain(
		Field formFieldParam, List multiChoiceValuesParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (multiChoiceValuesParam == null) {
			multiChoiceValuesParam = new ArrayList();
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.MultipleChoice);
			formFieldParam.setTypeMetaData(FieldMetaData.MultiChoice.PLAIN);
			formFieldParam.setFieldValue(new MultiChoice(multiChoiceValuesParam));
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Multi Choice field with Search abilities.
	 *
	 * @param formFieldParam Field to Create.
	 * @param multiChoiceValuesParam The available multi choice values.
	 * @return Created Field.
	 */
	public Field createFieldMultiChoicePlainWithSearch(
		Field formFieldParam, List multiChoiceValuesParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (multiChoiceValuesParam == null || multiChoiceValuesParam.isEmpty()) {
			throw new FluidClientException(
					"No Multi-choice values provided.",
					FluidClientException.ErrorCode.FIELD_VALIDATE);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.MultipleChoice);
			formFieldParam.setTypeMetaData(FieldMetaData.MultiChoice.PLAIN_SEARCH);
			formFieldParam.setFieldValue(new MultiChoice(multiChoiceValuesParam));
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Multi Choice select Many field.
	 *
	 * @param formFieldParam Field to Create.
	 * @param multiChoiceValuesParam The available multi choice values.
	 * @return Created Field.
	 */
	public Field createFieldMultiChoiceSelectMany(
		Field formFieldParam, List multiChoiceValuesParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (multiChoiceValuesParam == null ||
				multiChoiceValuesParam.isEmpty()) {
			throw new FluidClientException(
					"No Multi-choice values provided.",
					FluidClientException.ErrorCode.FIELD_VALIDATE);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.MultipleChoice);
			formFieldParam.setTypeMetaData(FieldMetaData.MultiChoice.SELECT_MANY);
			formFieldParam.setFieldValue(new MultiChoice(multiChoiceValuesParam));
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Multi Choice select Many field with Search.
	 *
	 * @param formFieldParam Field to Create.
	 * @param multiChoiceValuesParam The available multi choice values.
	 * @return Created Field.
	 */
	public Field createFieldMultiChoiceSelectManyWithSearch(
		Field formFieldParam, List multiChoiceValuesParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (multiChoiceValuesParam == null ||
				multiChoiceValuesParam.isEmpty()) {
			throw new FluidClientException(
					"No Multi-choice values provided.",
					FluidClientException.ErrorCode.FIELD_VALIDATE);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.MultipleChoice);
			formFieldParam.setTypeMetaData(FieldMetaData.MultiChoice.SELECT_MANY_SEARCH);
			formFieldParam.setFieldValue(new MultiChoice(multiChoiceValuesParam));
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Date only field.
	 *
	 * @param formFieldParam Field to Create.
	 * @return Created Field.
	 */
	public Field createFieldDateTimeDate(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.DateTime);
			formFieldParam.setTypeMetaData(FieldMetaData.DateTime.DATE);
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Date and time field.
	 *
	 * @param formFieldParam Field to Create.
	 * @return Created Field.
	 */
	public Field createFieldDateTimeDateAndTime(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.DateTime);
			formFieldParam.setTypeMetaData(FieldMetaData.DateTime.DATE_AND_TIME);
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Decimal field.
	 *
	 * @param formFieldParam Field to Create.
	 * @return Created Field.
	 */
	public Field createFieldDecimalPlain(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Decimal);
			formFieldParam.setTypeMetaData(FieldMetaData.Decimal.PLAIN);
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Decimal Spinner field.
	 *
	 * @param formFieldParam Field to Create.
	 * @param minParam The min allowed value.
	 * @param maxParam The max allowed value.
	 * @param stepFactorParam The increment factor.
	 * @param prefixParam The Prefix of the spinner. Example. $.
	 * @return Created Field.
	 */
	public Field createFieldDecimalSpinner(
		Field formFieldParam,
		double minParam,
		double maxParam,
		double stepFactorParam,
		String prefixParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) formFieldParam.setServiceTicket(this.serviceTicket);

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Decimal);
			formFieldParam.setTypeMetaData(
					this.getMetaDataForDecimalAs(
							FieldMetaData.Decimal.SPINNER,
							minParam, maxParam, stepFactorParam, prefixParam));
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Decimal Slider field.
	 *
	 * @param formFieldParam Field to Create.
	 * @param minParam The min allowed value.
	 * @param maxParam The max allowed value.
	 * @param stepFactorParam The increment factor.
	 * @return Created Field.
	 */
	public Field createFieldDecimalSlider(
		Field formFieldParam,
		double minParam,
		double maxParam,
		double stepFactorParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Decimal);
			formFieldParam.setTypeMetaData(
					this.getMetaDataForDecimalAs(
							FieldMetaData.Decimal.SLIDER,
							minParam,maxParam, stepFactorParam,
							null));
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Create a new Decimal Rating field.
	 *
	 * @param formFieldParam Field to Create.
	 * @param minParam The min allowed value.
	 * @param maxParam The max allowed value.
	 * @return Created Field.
	 */
	public Field createFieldDecimalRating(
		Field formFieldParam,
		double minParam,
		double maxParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Decimal);
			formFieldParam.setTypeMetaData(
					this.getMetaDataForDecimalAs(
							FieldMetaData.Decimal.RATING,
							minParam, maxParam, 0.0, null));
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Creates a new Table Field.
	 *
	 * @param formFieldParam The Base field to create.
	 * @param formDefinitionParam The Form Definition for the Table Field.
	 * @param sumDecimalsParam Whether decimals should be summed.
	 * @return Table Field.
	 */
	public Field createFieldTable(
		Field formFieldParam,
		Form formDefinitionParam,
		boolean sumDecimalsParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Table);
			formFieldParam.setTypeMetaData(
					this.getMetaDataForTableField(
							formDefinitionParam, sumDecimalsParam));
		}

		return new Field(this.putJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldCreate()));
	}

	/**
	 * Update an existing Text field.
	 *
	 * @param formFieldParam Field to Update.
	 * @return Updated Field.
	 */
	public Field updateFieldTextPlain(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Text);
			formFieldParam.setTypeMetaData(FieldMetaData.Text.PLAIN);
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Update an existing Masked Text field.
	 *
	 * @param formFieldParam Field to Update.
	 * @param maskValueParam The new masked value.
	 * @return Updated Field.
	 */
	public Field updateFieldTextMasked(Field formFieldParam, String maskValueParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (maskValueParam == null || maskValueParam.trim().isEmpty()) {
			throw new FluidClientException(
					"Masked value cannot be empty.",
					FluidClientException.ErrorCode.FIELD_VALIDATE);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Text);
			formFieldParam.setTypeMetaData(FieldMetaData.Text.MASKED.concat(maskValueParam));
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Update an existing Barcode Text field.
	 *
	 * @param formFieldParam Field to Update.
	 * @param barcodeTypeParam The new type of barcode image.
	 * @return Updated Field.
	 */
	public Field updateFieldTextBarcode(Field formFieldParam, String barcodeTypeParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (barcodeTypeParam == null || barcodeTypeParam.trim().isEmpty()) {
			throw new FluidClientException(
					"Barcode type cannot be empty.",
					FluidClientException.ErrorCode.FIELD_VALIDATE);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Text);
			formFieldParam.setTypeMetaData(FieldMetaData.Text.BARCODE.concat(barcodeTypeParam));
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Update an existing Latitude Longitude Text field.
	 *
	 * @param formFieldParam Field to Update.
	 * @return Updated Field.
	 */
	public Field updateFieldTextLatitudeAndLongitude(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Text);
			formFieldParam.setTypeMetaData(FieldMetaData.Text.LATITUDE_AND_LONGITUDE);
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Update an existing True False field.
	 *
	 * @param formFieldParam Field to Update.
	 * @return Updated Field.
	 */
	public Field updateFieldTrueFalse(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.TrueFalse);
			formFieldParam.setTypeMetaData(FieldMetaData.TrueFalse.TRUE_FALSE);
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Update an existing Paragraph Text field.
	 *
	 * @param formFieldParam Field to Update.
	 * @return Updated Field.
	 */
	public Field updateFieldParagraphTextPlain(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.ParagraphText);
			formFieldParam.setTypeMetaData(FieldMetaData.ParagraphText.PLAIN);
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Update an existing Paragraph HTML field.
	 *
	 * @param formFieldParam Field to Update.
	 * @return Updated Field.
	 */
	public Field updateFieldParagraphTextHTML(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.ParagraphText);
			formFieldParam.setTypeMetaData(FieldMetaData.ParagraphText.HTML);
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Update an existing Multi Choice field.
	 *
	 * @param formField Field to Update.
	 * @param multiChoiceValues New available Multi-choices.
	 * @return Updated Field.
	 */
	public Field updateFieldMultiChoicePlain(
		Field formField,
		List multiChoiceValues
	) {
		if (multiChoiceValues == null || multiChoiceValues.isEmpty()) {
			throw new FluidClientException(
					"No Multi-choice values provided.", FluidClientException.ErrorCode.FIELD_VALIDATE);
		}

		List beforeAvail = null, beforeSelected = null;
		if (formField != null) {
			formField.setServiceTicket(this.serviceTicket);
			formField.setTypeAsEnum(Field.Type.MultipleChoice);
			formField.setTypeMetaData(FieldMetaData.MultiChoice.PLAIN);

			if (formField.getFieldValue() instanceof MultiChoice) {
				MultiChoice casted = (MultiChoice)formField.getFieldValue();
				beforeAvail = casted.getAvailableMultiChoices();
				beforeSelected = casted.getSelectedMultiChoices();
			}

			formField.setFieldValue(new MultiChoice(multiChoiceValues));
		}

		Field returnVal = new Field(this.postJson(formField, WS.Path.FormField.Version1.formFieldUpdate()));
		if (formField != null) {
			formField.setFieldValue(new MultiChoice(beforeSelected, beforeAvail));
		}

		return returnVal;
	}

	/**
	 * Update an existing Multi Choice field with Search.
	 *
	 * @param formField Field to Update.
	 * @param multiChoiceValues New available Multi-choices.
	 * @return Updated Field.
	 */
	public Field updateFieldMultiChoicePlainWithSearch(Field formField, List multiChoiceValues) {
		if (formField != null && this.serviceTicket != null) {
			formField.setServiceTicket(this.serviceTicket);
		}

		if (multiChoiceValues == null ||
				multiChoiceValues.isEmpty()) {
			throw new FluidClientException(
					"No Multi-choice values provided.",
					FluidClientException.ErrorCode.FIELD_VALIDATE);
		}

		List beforeAvail = null, beforeSelected = null;
		if (formField != null) {
			formField.setTypeAsEnum(Field.Type.MultipleChoice);
			formField.setTypeMetaData(FieldMetaData.MultiChoice.PLAIN_SEARCH);

			if (formField.getFieldValue() instanceof MultiChoice) {
				MultiChoice casted = (MultiChoice)formField.getFieldValue();
				beforeAvail = casted.getAvailableMultiChoices();
				beforeSelected = casted.getSelectedMultiChoices();
			}

			formField.setFieldValue(new MultiChoice(multiChoiceValues));
		}

		Field returnVal = new Field(this.postJson(
				formField, WS.Path.FormField.Version1.formFieldUpdate()));
		if (formField != null){
			formField.setFieldValue(new MultiChoice(beforeSelected, beforeAvail));
		}

		return returnVal;
	}

	/**
	 * Update an existing Multi Choice select many field.
	 *
	 * @param formFieldParam Field to Update.
	 * @param multiChoiceValuesParam New available Multi-choices.
	 * @return Updated Field.
	 */
	public Field updateFieldMultiChoiceSelectMany(
		Field formFieldParam,
		List multiChoiceValuesParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (multiChoiceValuesParam == null || multiChoiceValuesParam.isEmpty()) {
			throw new FluidClientException(
					"No Multi-choice values provided.",
					FluidClientException.ErrorCode.FIELD_VALIDATE);
		}

		List beforeAvail = null, beforeSelected = null;
		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.MultipleChoice);
			formFieldParam.setTypeMetaData(FieldMetaData.MultiChoice.SELECT_MANY);

			if (formFieldParam.getFieldValue() instanceof MultiChoice){
				MultiChoice casted = (MultiChoice)formFieldParam.getFieldValue();
				beforeAvail = casted.getAvailableMultiChoices();
				beforeSelected = casted.getSelectedMultiChoices();
			}

			formFieldParam.setFieldValue(new MultiChoice(multiChoiceValuesParam));
		}

		Field returnVal = new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
		if (formFieldParam != null){
			formFieldParam.setFieldValue(new MultiChoice(beforeSelected, beforeAvail));
		}

		return returnVal;
	}

	/**
	 * Update an existing Multi Choice select many field with Search.
	 *
	 * @param formFieldParam Field to Update.
	 * @param multiChoiceValuesParam New available Multi-choices.
	 * @return Updated Field.
	 */
	public Field updateFieldMultiChoiceSelectManyWithSearch(
			Field formFieldParam,
			List multiChoiceValuesParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (multiChoiceValuesParam == null ||
				multiChoiceValuesParam.isEmpty()) {
			throw new FluidClientException(
					"No Multi-choice values provided.",
					FluidClientException.ErrorCode.FIELD_VALIDATE);
		}

		List beforeAvail = null, beforeSelected = null;
		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.MultipleChoice);
			formFieldParam.setTypeMetaData(FieldMetaData.MultiChoice.SELECT_MANY_SEARCH);

			if (formFieldParam.getFieldValue() instanceof MultiChoice){
				MultiChoice casted = (MultiChoice)formFieldParam.getFieldValue();
				beforeAvail = casted.getAvailableMultiChoices();
				beforeSelected = casted.getSelectedMultiChoices();
			}

			formFieldParam.setFieldValue(new MultiChoice(multiChoiceValuesParam));
		}

		Field returnVal = new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
		if (formFieldParam != null){
			formFieldParam.setFieldValue(new MultiChoice(beforeSelected, beforeAvail));
		}

		return returnVal;
	}

	/**
	 * Update an existing Date field.
	 *
	 * @param formFieldParam Field to Update.
	 * @return Updated Field.
	 */
	public Field updateFieldDateTimeDate(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.DateTime);
			formFieldParam.setTypeMetaData(FieldMetaData.DateTime.DATE);
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Update an existing Date and Time field.
	 *
	 * @param formFieldParam Field to Update.
	 * @return Updated Field.
	 */
	public Field updateFieldDateTimeDateAndTime(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.DateTime);
			formFieldParam.setTypeMetaData(FieldMetaData.DateTime.DATE_AND_TIME);
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Update an existing Decimal field.
	 *
	 * @param formFieldParam Field to Update.
	 * @return Updated Field.
	 */
	public Field updateFieldDecimalPlain(Field formFieldParam) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Decimal);
			formFieldParam.setTypeMetaData(FieldMetaData.Decimal.PLAIN);
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Updates the Decimal Spinner field.
	 *
	 * @param formFieldParam The Field.
	 * @param minParam The min allowed value.
	 * @param maxParam The max allowed value.
	 * @param stepFactorParam The increments or step factor.
	 * @param prefixParam The prefix to the decimal. Example is $ for currency.
	 *
	 * @return Updated Decimal Spinner.
	 */
	public Field updateFieldDecimalSpinner(
		Field formFieldParam,
		double minParam,
		double maxParam,
		double stepFactorParam,
		String prefixParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Decimal);
			formFieldParam.setTypeMetaData(
					this.getMetaDataForDecimalAs(
							FieldMetaData.Decimal.SPINNER,
							minParam,maxParam, stepFactorParam, prefixParam));
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Updates the Decimal Slider field.
	 *
	 * @param formFieldParam The Field.
	 * @param minParam The min allowed value.
	 * @param maxParam The max allowed value.
	 * @param stepFactorParam The increments or step factor.
	 *
	 * @return Updated Decimal Slider.
	 */
	public Field updateFieldDecimalSlider(
		Field formFieldParam,
		double minParam,
		double maxParam,
		double stepFactorParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Decimal);
			formFieldParam.setTypeMetaData(
					this.getMetaDataForDecimalAs(
							FieldMetaData.Decimal.SLIDER,
							minParam,maxParam, stepFactorParam, null));
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Updates the Decimal Rating field.
	 *
	 * @param formFieldParam The Field.
	 * @param minParam The min allowed value.
	 * @param maxParam The max allowed value.
	 *
	 * @return Updated Decimal Rating.
	 */
	public Field updateFieldDecimalRating(
		Field formFieldParam,
		double minParam,
		double maxParam
	) {
		if (formFieldParam != null && this.serviceTicket != null) {
			formFieldParam.setServiceTicket(this.serviceTicket);
		}

		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Decimal);
			formFieldParam.setTypeMetaData(
					this.getMetaDataForDecimalAs(
							FieldMetaData.Decimal.RATING,
							minParam,maxParam, 0.0, null));
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Updates a Table Field.
	 *
	 * @param formFieldParam The Field to Update.
	 * @param formDefinitionParam The Form Definition to Update.
	 * @param sumDecimalsParam Whether decimals should be summed.
	 *
	 * @return Updated Field.
	 */
	public Field updateFieldTable(
		Field formFieldParam,
		Form formDefinitionParam,
		boolean sumDecimalsParam
	) {
		formFieldParam.setServiceTicket(this.serviceTicket);
		if (formFieldParam != null) {
			formFieldParam.setTypeAsEnum(Field.Type.Table);
			formFieldParam.setTypeMetaData(
					this.getMetaDataForTableField(
							formDefinitionParam, sumDecimalsParam));
		}

		return new Field(this.postJson(
				formFieldParam, WS.Path.FormField.Version1.formFieldUpdate()));
	}

	/**
	 * Retrieve a Form Field via Primary key.
	 *
	 * @param fieldIdParam The field Primary Key.
	 * @return Field and properties.
	 */
	public Field getFieldById(Long fieldIdParam) {
		Field field = new Field(fieldIdParam);
		//Set for Payara server...
		field.setFieldValue(new MultiChoice());
		field.setServiceTicket(this.serviceTicket);

		if (this.requestUuid != null) field.setRequestUuid(this.requestUuid);

		return new Field(this.postJson(
				field, WS.Path.FormField.Version1.getById()));
	}

	/**
	 * Retrieve a Form Field via name.
	 *
	 * @param fieldNameParam The field name.
	 * @return Field and properties.
	 */
	public Field getFieldByName(String fieldNameParam) {
		Field field = new Field();
		field.setFieldName(fieldNameParam);
		if (this.serviceTicket != null) {
			field.setServiceTicket(this.serviceTicket);
		}
		return new Field(this.postJson(
				field, WS.Path.FormField.Version1.getByName()));
	}

	/**
	 * Retrieve the Form Fields via Form Definition name.
	 *
	 * @param formNameParam The form definition name.
	 * @param editOnlyFieldsParam Only return the fields that are editable.
	 *
	 * @return Form Fields for {@code formNameParam}
	 */
	public FormFieldListing getFieldsByFormNameAndLoggedInUser(String formNameParam, boolean editOnlyFieldsParam) {
		return this.getFieldsByFormNameAndLoggedInUser(formNameParam, editOnlyFieldsParam, false);
	}

	/**
	 * Retrieve the Form Fields via Form Definition name.
	 *
	 * @param formNameParam The form definition name.
	 * @param editOnlyFieldsParam Only return the fields that are editable.
	 * @param populateMultiChoiceFields Populate the multi-choice fields.
	 *
	 * @return Form Fields for {@code formNameParam}
	 */
	public FormFieldListing getFieldsByFormNameAndLoggedInUser(
		String formNameParam,
		boolean editOnlyFieldsParam,
		boolean populateMultiChoiceFields
	) {
		Form form = new Form();
		form.setFormType(formNameParam);

		if (this.serviceTicket != null) form.setServiceTicket(this.serviceTicket);
		if (this.requestUuid != null) form.setRequestUuid(this.requestUuid);

		return new FormFieldListing(this.postJson(
				form, WS.Path.FormField.Version1.getByFormDefinitionAndLoggedInUser(
						editOnlyFieldsParam, populateMultiChoiceFields)));
	}

	/**
	 * Retrieve the Form Fields via Form Definition names.
	 *
	 * @param editOnlyFieldsParam Only return the fields that are editable.
	 * @param populateMultiChoiceFields Populate the multi-choice fields.
	 * @param formNamesParam The form definition names.
	 *
	 * @return Form Fields for {@code formNameParam}
	 */
	public List
     getFieldsByFormNamesAndLoggedInUser(
		boolean editOnlyFieldsParam,
		boolean populateMultiChoiceFields,
		List formNamesParam
	) {
		if (formNamesParam == null || formNamesParam.isEmpty()) return new ArrayList<>();
		FormListing formListing = new FormListing();
		formListing.setListing(formNamesParam.stream().map(itm -> {
					Form form = new Form();
					form.setFormType(itm);
					return form;
				})
				.collect(Collectors.toList()));

		if (this.serviceTicket != null) formListing.setServiceTicket(this.serviceTicket);
		if (this.requestUuid != null) formListing.setRequestUuid(this.requestUuid);

		return new FormListing(this.postJson(
				formListing, WS.Path.FormField.Version1.getByFormDefinitionsAndLoggedInUser(
						editOnlyFieldsParam, populateMultiChoiceFields))).getListing();
	}

	/**
	 * Retrieve the Form Fields via Form Definition names.
	 *
	 * @param editOnlyFieldsParam Only return the fields that are editable.
	 * @param populateMultiChoiceFields Populate the multi-choice fields.
	 * @param formNamesParam The form definition names.
	 *
	 * @return Form Fields for {@code formNameParam}
	 */
	public List getFieldsByFormNamesAndLoggedInUser(
		boolean editOnlyFieldsParam,
		boolean populateMultiChoiceFields,
		String ... formNamesParam
	) {
		if (formNamesParam == null || formNamesParam.length == 0) return new ArrayList<>();
		List formList = new ArrayList<>();
		for (String formName : formNamesParam) {
			Form form = new Form();
			form.setFormType(formName);
			formList.add(form);
		}

		FormListing formListing = new FormListing();
		formListing.setListing(formList);

		if (this.serviceTicket != null) formListing.setServiceTicket(this.serviceTicket);
		if (this.requestUuid != null) formListing.setRequestUuid(this.requestUuid);

		return new FormListing(this.postJson(
				formListing, WS.Path.FormField.Version1.getByFormDefinitionsAndLoggedInUser(
						editOnlyFieldsParam, populateMultiChoiceFields))).getListing();
	}


	/**
	 * Retrieve the Form Fields via Form Definition names.
	 *
	 * @param editOnlyFieldsParam Only return the fields that are editable.
	 * @param populateMultiChoiceFields Populate the multi-choice fields.
	 * @param formIdsParam The form definition names.
	 *
	 * @return Form Fields for {@code formNameParam}
	 */
	public List getFieldsByFormIdsAndLoggedInUser(
		boolean editOnlyFieldsParam,
		boolean populateMultiChoiceFields,
		List formIdsParam
	) {
		if (formIdsParam == null || formIdsParam.isEmpty()) return new ArrayList<>();
		FormListing formListing = new FormListing();
		formListing.setListing(formIdsParam.stream().map(itm -> new Form(itm)).collect(Collectors.toList()));

		if (this.serviceTicket != null) formListing.setServiceTicket(this.serviceTicket);
		if (this.requestUuid != null) formListing.setRequestUuid(this.requestUuid);

		return new FormListing(this.postJson(
				formListing, WS.Path.FormField.Version1.getByFormDefinitionsAndLoggedInUser(
						editOnlyFieldsParam, populateMultiChoiceFields))).getListing();
	}

	/**
	 * Retrieve the Form Fields via Form Definition names.
	 *
	 * @param editOnlyFieldsParam Only return the fields that are editable.
	 * @param populateMultiChoiceFields Populate the multi-choice fields.
	 * @param formIdsParam The form definition ids.
	 *
	 * @return Form Fields for {@code formNameParam}
	 */
	public List getFieldsByFormIdsAndLoggedInUser(
		boolean editOnlyFieldsParam,
		boolean populateMultiChoiceFields,
		Long ... formIdsParam
	) {
		if (formIdsParam == null || formIdsParam.length == 0) return new ArrayList<>();
		List formList = new ArrayList<>();
		for (Long formId : formIdsParam) formList.add(new Form(formId));

		FormListing formListing = new FormListing();
		formListing.setListing(formList);

		if (this.serviceTicket != null) formListing.setServiceTicket(this.serviceTicket);
		if (this.requestUuid != null) formListing.setRequestUuid(this.requestUuid);

		return new FormListing(this.postJson(
				formListing, WS.Path.FormField.Version1.getByFormDefinitionsAndLoggedInUser(
						editOnlyFieldsParam, populateMultiChoiceFields))).getListing();
	}

	/**
	 * Retrieve the Form Fields via User Query.
	 *
	 * @param userQuery The user query.
	 *
	 * @return Form Fields for {@code userQuery}
	 */
	public List getFormFieldsByUserQuery(UserQuery userQuery) {
		if (userQuery != null) userQuery.setServiceTicket(this.serviceTicket);

		return new FormFieldListing(this.postJson(
				userQuery, WS.Path.FormField.Version1.getByUserQuery())).getListing();
	}

	/**
	 * Retrieve the Form Fields via User Query.
	 *
	 * @param userQueries The user queries to fetch fields for.
	 *
	 * @return Form Fields for {@code userQuery}
	 */
	public List getFormFieldsByUserQueries(List userQueries) {
		if (userQueries == null || userQueries.isEmpty()) return new ArrayList<>();

		UserQueryListing userQueryListing = new UserQueryListing();
		userQueryListing.setListing(userQueries.stream()
				.map(toAdd -> new UserQuery(toAdd.getId(), toAdd.getName()))
				.collect(Collectors.toList()));
		userQueryListing.setServiceTicket(this.serviceTicket);
		userQueryListing.setListingCount(userQueries.size());

		return new UserQueryListing(this.postJson(
				userQueryListing, WS.Path.FormField.Version1.getByUserQueries())).getListing();
	}

	/**
	 * Retrieve the Form Fields via Form Definition id.
	 *
	 * @param formTypeIdParam The form definition id.
	 * @param editOnlyFieldsParam Only return the fields that are editable.
	 * @param populateMultiChoiceFields Populate the multi-choice fields.
	 *
	 * @return Form Fields for {@code formIdParam}
	 */
	public FormFieldListing getFieldsByFormTypeIdAndLoggedInUser(
		Long formTypeIdParam,
		boolean editOnlyFieldsParam,
		boolean populateMultiChoiceFields
	) {
		Form form = new Form();
		form.setFormTypeId(formTypeIdParam);

		if (this.serviceTicket != null) form.setServiceTicket(this.serviceTicket);

		return new FormFieldListing(this.postJson(
				form, WS.Path.FormField.Version1.getByFormDefinitionAndLoggedInUser(
						editOnlyFieldsParam, populateMultiChoiceFields)));
	}

	/**
	 * Deletes the provided field.
	 *
	 * Ensure that Id is set.
	 *
	 * @param fieldParam The Field to delete.
	 * @return The deleted Field.
	 */
	public Field deleteField(Field fieldParam) {
		if (fieldParam != null && this.serviceTicket != null) {
			fieldParam.setServiceTicket(this.serviceTicket);
		}
		return new Field(this.postJson(fieldParam, WS.Path.FormField.Version1.formFieldDelete()));
	}

	/**
	 * Forcefully deletes the provided field.
	 *
	 * Ensure that Id is set.
	 *
	 * Only 'admin' is able to forcefully delete a field.
	 *
	 * @param fieldParam The Field to delete.
	 * @return The deleted Field.
	 */
	public Field forceDeleteField(Field fieldParam) {
		if (fieldParam != null && this.serviceTicket != null) {
			fieldParam.setServiceTicket(this.serviceTicket);
		}
		return new Field(this.postJson(
				fieldParam, WS.Path.FormField.Version1.formFieldDelete(true)));
	}

	/**
	 * Generates the Meta Data for a table field.
	 *
	 * @param formDefinitionParam The Form Definition to use.
	 * @param sumDecimalsParam Whether decimal values should be summarized.
	 * @return Meta Data for the Table Field.
	 */
	private String getMetaDataForTableField(
		Form formDefinitionParam,
		boolean sumDecimalsParam
	) {
		StringBuilder returnBuffer = new StringBuilder();
		Long definitionId =
				(formDefinitionParam == null) ? -1L:
						formDefinitionParam.getId();

		//Min...
		returnBuffer.append(definitionId);
		returnBuffer.append(FieldMetaData.TableField.UNDERSCORE);
		returnBuffer.append(FieldMetaData.TableField.SUM_DECIMALS);
		returnBuffer.append(FieldMetaData.Decimal.SQ_OPEN);
		returnBuffer.append(sumDecimalsParam);
		returnBuffer.append(FieldMetaData.Decimal.SQ_CLOSE);

		return returnBuffer.toString();
	}
}




    © 2015 - 2025 Weber Informatics LLC | Privacy Policy