com.fluidbpm.ws.client.v1.form.FormDefinitionClient Maven / Gradle / Ivy

Go to download
/*
 * 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.vo.field.Field;
import com.fluidbpm.program.api.vo.form.Form;
import com.fluidbpm.program.api.vo.form.FormListing;
import com.fluidbpm.program.api.vo.webkit.form.WebKitForm;
import com.fluidbpm.program.api.vo.webkit.form.WebKitFormListing;
import com.fluidbpm.program.api.vo.ws.WS;
import com.fluidbpm.ws.client.v1.ABaseClientWS;
import org.json.JSONObject;

import java.util.List;

/**
 * Java Web Service Client for Form Definition related actions.
 *
 * @author jasonbruwer
 * @since v1.0
 *
 * @see JSONObject
 * @see com.fluidbpm.program.api.vo.ws.WS.Path.FormDefinition
 * @see Form
 */
public class FormDefinitionClient extends ABaseClientWS {

	/**
	 * Constructor that sets the Service Ticket from authentication.
	 *
	 * @param endpointBaseUrlParam URL to base endpoint.
	 * @param serviceTicketParam The Server issued Service Ticket.
	 */
	public FormDefinitionClient(
			String endpointBaseUrlParam,
			String serviceTicketParam) {
		super(endpointBaseUrlParam, serviceTicketParam);
	}

	/**
	 * 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 FormDefinitionClient(
			String endpointBaseUrlParam,
			String serviceTicketParam,
			String requestUuidParam
	) {
		super(endpointBaseUrlParam, serviceTicketParam, requestUuidParam);
	}

	/**
	 * Creates a new Form Definition with the Fields inside the definition.
	 *
	 * @param formDefinitionParam The Definition to create.
	 * @return The Created Form Definition.
	 *
	 * @see Field
	 * @see Form
	 */
	public Form createFormDefinition(Form formDefinitionParam) {
		if (formDefinitionParam != null && this.serviceTicket != null) {
			formDefinitionParam.setServiceTicket(this.serviceTicket);
		}

		return new Form(this.putJson(
				formDefinitionParam, WS.Path.FormDefinition.Version1.formDefinitionCreate()));
	}

	/**
	 * Updates an existing Form Definition with the Fields inside the definition.
	 *
	 * @param formDefinitionParam The Definition to update.
	 * @return The Updated Form Definition.
	 *
	 * @see Field
	 * @see Form
	 */
	public Form updateFormDefinition(Form formDefinitionParam) {
		if (formDefinitionParam != null && this.serviceTicket != null) {
			formDefinitionParam.setServiceTicket(this.serviceTicket);
		}

		return new Form(this.postJson(
				formDefinitionParam,
				WS.Path.FormDefinition.Version1.formDefinitionUpdate()));
	}

	/**
	 * Retrieves the Form Definition by Primary key.
	 *
	 * @param formDefinitionIdParam The Form Definition primary key.
	 * @return Form by Primary key.
	 */
	public Form getFormDefinitionById(Long formDefinitionIdParam) {
		Form form = new Form(formDefinitionIdParam);

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

		return new Form(this.postJson(
				form, WS.Path.FormDefinition.Version1.getById()));
	}

	/**
	 * Retrieves the Form Definition by Name.
	 *
	 * @param formDefinitionNameParam The Form Definition name.
	 * @return Form by Name.
	 */
	public Form getFormDefinitionByName(String formDefinitionNameParam) {
		Form form = new Form(formDefinitionNameParam);

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

		if (this.requestUuid != null) {
			form.setRequestUuid(this.requestUuid);
		}
		
		return new Form(this.postJson(
				form, WS.Path.FormDefinition.Version1.getByName()));
	}

	/**
	 * Retrieves all Form Definitions by logged in user.
	 *
	 * @param includeTableRecordTypesParam Include the Table Record form definitions.
	 *
	 * @return List of Form Definitions.
	 */
	public List getAllByLoggedInUser(boolean includeTableRecordTypesParam) {
		Form form = new Form();

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

		if (this.requestUuid != null) {
			form.setRequestUuid(this.requestUuid);
		}

		if (includeTableRecordTypesParam) {
			return new FormListing(this.postJson(
					form, WS.Path.FormDefinition.Version1.getAllByLoggedInUserIncludeTableTypes())).getListing();
		} else {
			return new FormListing(this.postJson(
					form, WS.Path.FormDefinition.Version1.getAllByLoggedInUser())).getListing();
		}
	}

	/**
	 * Retrieves all Form Definitions where the logged in user can
	 * create a new instance of the {@code Form}.
	 *
	 * Form Definitions used for table records will be excluded.
	 *
	 * @return List of Form Definitions.
	 */
	public List getAllByLoggedInUserWhereCanCreateInstanceOf() {
		return this.getAllByLoggedInUserWhereCanCreateInstanceOf(false);
	}

	/**
	 * Retrieves all Form Definitions where the logged in user can
	 * create a new instance of the {@code Form}.
	 *
	 * @param includeTableRecordsParam Should Form Definitions that are part of table records also be
	 *                                 included?
	 *
	 * @return List of Form Definitions.
	 */
	public List getAllByLoggedInUserWhereCanCreateInstanceOf(
			boolean includeTableRecordsParam
	) {
		Form form = new Form();
		form.setServiceTicket(this.serviceTicket);
		form.setRequestUuid(this.requestUuid);

		return new FormListing(this.postJson(
				form, WS.Path.FormDefinition.Version1.getAllByLoggedInAndCanCreateInstanceOf(
						includeTableRecordsParam, false))).
				getListing();
	}

	/**
	 * Retrieves all Form Definitions where the logged in user can
	 * create a new instance of the {@code Form}.
	 *
	 * @param includeTableRecordsParam Should Form Definitions that are part of table records also be included?
	 * @param includeWorkflowsParam Should list of associated workflows be included in the response?
	 *
	 * @return List of Form Definitions.
	 */
	public List getAllByLoggedInUserWhereCanCreateInstanceOf(
		boolean includeTableRecordsParam,
		boolean includeWorkflowsParam
	) {
		Form form = new Form();
		form.setServiceTicket(this.serviceTicket);
		form.setRequestUuid(this.requestUuid);

		return new FormListing(this.postJson(
				form, WS.Path.FormDefinition.Version1.getAllByLoggedInAndCanCreateInstanceOf(
						includeTableRecordsParam, includeWorkflowsParam))).getListing();
	}

	/**
	 * Retrieves all Form Definitions where the logged in user can
	 * view attachments for those form definitions.
	 *
	 * @return List of Form Definitions.
	 */
	public List getAllByLoggedInUserWhereCanViewAttachments() {
		Form form = new Form();
		form.setServiceTicket(this.serviceTicket);
		form.setRequestUuid(this.requestUuid);

		return new FormListing(this.postJson(
				form, WS.Path.FormDefinition.Version1.getAllByLoggedInAndAttachmentsCanView())).
				getListing();
	}

	/**
	 * Retrieves all Form Definitions where the logged in user can
	 * edit attachments for those form definitions.
	 *
	 * @return List of Form Definitions.
	 */
	public List getAllByLoggedInUserWhereCanEditAttachments() {
		Form form = new Form();
		form.setServiceTicket(this.serviceTicket);
		form.setRequestUuid(this.requestUuid);

		return new FormListing(this.postJson(
				form, WS.Path.FormDefinition.Version1.getAllByLoggedInAndAttachmentsCanEdit())).
				getListing();
	}

	/**
	 * Deletes the Form Definition provided.
	 * Id must be set on the Form Definition.
	 *
	 * @param formDefinitionParam The Form Definition to Delete.
	 * @return The deleted Form Definition.
	 */
	public Form deleteFormDefinition(Form formDefinitionParam) {
		if (formDefinitionParam != null && this.serviceTicket != null) formDefinitionParam.setServiceTicket(this.serviceTicket);

		if (formDefinitionParam != null && this.requestUuid != null) formDefinitionParam.setRequestUuid(this.requestUuid);

		if (formDefinitionParam.getFormTypeId() == null || formDefinitionParam.getFormTypeId().longValue() < 1) {
			formDefinitionParam.setFormTypeId(formDefinitionParam.getId());
		}

		return new Form(this.postJson(formDefinitionParam,
				WS.Path.FormDefinition.Version1.formDefinitionDelete()));
	}

	/**
	 * Retrieve all the WebKits for all the form definitions.
	 *
	 * @return All the Form Definition web kits.
	 * @see WebKitForm
	 * @see WebKitFormListing
	 */
	public List getAllFormWebKits() {
		WebKitFormListing webKitFormListing = new WebKitFormListing();
		webKitFormListing.setServiceTicket(this.serviceTicket);

		return new WebKitFormListing(this.postJson(
				webKitFormListing,
				WS.Path.FormDefinition.Version1.getAllFormDefinitionWebKits())).getListing();
	}

	/**
	 * Update and insert the Form Definition configuration.
	 *
	 * @param listing The WebKitFormListing listing to upsert.
	 * @return The complete form definition config.
	 * @see WebKitFormListing
	 */
	public WebKitFormListing upsertFormWebKit(WebKitFormListing listing) {
		if (listing == null) return null;

		listing.setServiceTicket(this.serviceTicket);
		return new WebKitFormListing(this.postJson(listing,
				WS.Path.FormDefinition.Version1.formDefinitionWebKitUpsert()));
	}

}