Package net.pricefx.server.dto.calculation

Class CustomFormApi

Object

CustomFormApi

public class CustomFormApi
extends Object

Utility class to work with Custom Forms in Groovy code

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomFormApi.CustomFormBuilder	Helper class to create Custom Forms.
static class	CustomFormApi.DocumentActionApi	Helper class to work with Custom Forms statuses.
static class	CustomFormApi.OperationsApi
static class	CustomFormApi.RecalculateApi	Helper class to recalculate Custom Forms.
static class	CustomFormApi.UpdateApi	Helper class to update Custom Forms.
static class	CustomFormApi.WorkflowActionApi	Helper class to work with Workflow statuses.

Constructor Summary

Constructors

Constructor	Description
CustomFormApi(FormulaEngineContext formulaEngineContext, ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method	Description
CustomFormApi.CustomFormBuilder	newCustomForm()	Initiates a builder object to create a new Custom Form.
CustomFormApi.OperationsApi	withId(Long id)	Initiates an operation with an existing Custom Form by id.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CustomFormApi

public CustomFormApi(FormulaEngineContext formulaEngineContext,
 ObjectMapper objectMapper)

Method Details

newCustomForm

public CustomFormApi.CustomFormBuilder newCustomForm()

Initiates a builder object to create a new Custom Form. The operation is finished with the create method.

Example:

 def customForm = api.customFormApi()
     .newCustomForm()
         .setName("CustomForm01)
         .setLabel("my custom form 1")
         .setTypeId(1)
         .setAttributeValue("attribute1", "meatball01")
         .setAttributeExtensionValue("name", "value")
         .setUserGroupViewDetails("viewGroup")
         .setUserGroupEdit("groupEdit")
     .create()
 

Returns:

this builder instance

withId

public CustomFormApi.OperationsApi withId(Long id)

Initiates an operation with an existing Custom Form by id. Please note that this is a numeric, database id, not a typedId. This is because this API is exclusively for Custom Forms only, so no other objects can be used, and no distinction on the type is then necessary.

Parameters:

id - The database id of an already existing Custom Form

Returns:

an Operations' builder instance

See Also:

• CustomFormApi.OperationsApi.updateData()
• CustomFormApi.OperationsApi.createRevision()
• CustomFormApi.OperationsApi.duplicate()
• CustomFormApi.OperationsApi.delete()