com.fluidbpm.program.api.vo.FluidItem 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
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.
/*
* 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;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import javax.xml.bind.annotation.XmlTransient;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
/**
* Represents an Electronic Form with all possible Meta-Data for an item
* in {@code Flow} / Workflow.
*
* @author jasonbruwer
* @since v1.0
*
* @see Form
* @see Field
* @see Attachment
* @see FlowState
* @see Properties
*/
public class FluidItem extends ABaseFluidJSONObject {
public static final long serialVersionUID = 1L;
private List userFields;
private List routeFields;
private List globalFields;
private Form form;
private List attachments;
private FlowState flowState;
private String flow;
private Boolean inCaseOfCreateLinkToParent;
private Form tableFieldParentForm;
private String tableFieldNameOnParentForm;
/**
* The JSON mapping for the {@code FluidItem} object.
*/
public static class JSONMapping
{
public static final String CUSTOM_PROPERTIES = "customProperties";
public static final String USER_FIELDS = "userFields";
public static final String ROUTE_FIELDS = "routeFields";
public static final String GLOBAL_FIELDS = "globalFields";
public static final String FORM = "form";
public static final String ATTACHMENTS = "attachments";
public static final String FLOW_STATE = "flowState";
public static final String FLOW = "flow";
}
/**
* Additional properties for {@code this} {@code FluidItem}.
*/
public static class FluidItemProperty extends ABaseFluidJSONObject
{
private String name;
private String value;
/**
* The JSON mapping for the {@code FluidItemProperty} object.
*/
public static class JSONMapping
{
public static final String NAME = "name";
public static final String VALUE = "value";
}
/**
* Default constructor.
*/
public FluidItemProperty() {
super();
}
/**
* Sets the Name and Value of the property.
*
* @param nameParam The Property Name.
* @param valueParam The Property Value.
*/
public FluidItemProperty(String nameParam, String valueParam) {
this.setName(nameParam);
this.setValue(valueParam);
}
/**
* Populates local variables with {@code jsonObjectParam}.
*
* @param jsonObjectParam The JSON Object.
*/
public FluidItemProperty(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));
}
}
/**
* 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;
}
/**
* Gets the Name of the Property.
*
* @return Property Name.
*/
public String getName() {
return this.name;
}
/**
* Sets the Name of the Property.
*
* @param nameParam Property Name.
*/
public void setName(String nameParam) {
this.name = nameParam;
}
/**
* Gets the Value of the Property.
*
* @return Property Value.
*/
public String getValue() {
return this.value;
}
/**
* Sets the Value of the Property.
*
* @param valueParam The value of the Fluid Item property.
*/
public void setValue(String valueParam) {
this.value = valueParam;
}
}
/**
* The {@code FlowState} that a {@code FluidItem}
* is currently in in terms of the Workflow.
*
*
* Flow States for an {@code FluidItem}.
*
* Flow State
* Description
*
*
* {@code NotInFlow}
* Item that is not currently in Flow. Item could have been in flow
* previously.
*
*
* {@code WorkInProgress}
* Item that is currently part of a {@code Flow} and needs attention.
*
*
* {@code UserSend}
* Electronic Form that is not currently part of a {@code Flow}, but shared with a
* colleague.
*
*
* {@code UserSend}
* Electronic Form that is not currently part of a {@code Flow}, but shared with a
* colleague.
*
*
* {@code UserSendWorkInProgress}
* Electronic Form that is currently part of a {@code Flow}, and shared with a
* colleague.
*
*
* {@code Archive}
* Electronic Form that has been completed and Archived for long term storage.
*
*
*/
public enum FlowState {
NotInFlow,
WorkInProgress,
UserSend,
UserSendWorkInProgress,
Archive;
/**
* Returns the {@code FlowState} based on {@code flowStateStringParam}.
*
* The {@code flowStateStringParam} value is not case sensitive.
*
* @param flowStateStringParam The name of the {@code enum} {@code FlowState}.
* @return {@code FlowState}, if {@code enum} from {@code flowStateStringParam}
* is not found, {@code null} will be returned.
*/
public static FlowState valueOfSafe(String flowStateStringParam)
{
if(flowStateStringParam == null || flowStateStringParam.trim().isEmpty())
{
return null;
}
String paramLower = flowStateStringParam.trim().toLowerCase();
for(FlowState flowState : FlowState.values())
{
if(paramLower.equals(flowState.name().toLowerCase()))
{
return flowState;
}
}
return null;
}
}
/**
* Default constructor.
*/
public FluidItem() {
super();
}
/**
* Populates local variables with {@code jsonObjectParam}.
*
* @param jsonObjectParam The JSON Object.
*/
public FluidItem(JSONObject jsonObjectParam){
super(jsonObjectParam);
if(this.jsonObject == null)
{
return;
}
//Custom Properties...
if (!this.jsonObject.isNull(JSONMapping.CUSTOM_PROPERTIES)) {
JSONArray jsonPropArray = this.jsonObject.getJSONArray(JSONMapping.CUSTOM_PROPERTIES);
List fluidItemProperties = new ArrayList();
for(int index = 0;index < jsonPropArray.length();index++)
{
fluidItemProperties.add(
new FluidItemProperty(jsonPropArray.getJSONObject(index)));
}
}
//User Fields...
if (!this.jsonObject.isNull(JSONMapping.USER_FIELDS)) {
JSONArray fieldsArr = this.jsonObject.getJSONArray(
JSONMapping.USER_FIELDS);
List assUserFields = new ArrayList();
for(int index = 0;index < fieldsArr.length();index++)
{
assUserFields.add(new Field(fieldsArr.getJSONObject(index)));
}
this.setUserFields(assUserFields);
}
//Route Fields...
if (!this.jsonObject.isNull(JSONMapping.ROUTE_FIELDS)) {
JSONArray fieldsArr = this.jsonObject.getJSONArray(
JSONMapping.ROUTE_FIELDS);
List assRouteFields = new ArrayList();
for(int index = 0;index < fieldsArr.length();index++)
{
assRouteFields.add(new Field(fieldsArr.getJSONObject(index)));
}
this.setRouteFields(assRouteFields);
}
//Global Fields...
if (!this.jsonObject.isNull(JSONMapping.GLOBAL_FIELDS)) {
JSONArray fieldsArr = this.jsonObject.getJSONArray(
JSONMapping.GLOBAL_FIELDS);
List assGlobalFields = new ArrayList();
for(int index = 0;index < fieldsArr.length();index++)
{
assGlobalFields.add(new Field(fieldsArr.getJSONObject(index)));
}
this.setGlobalFields(assGlobalFields);
}
//Attachments...
if (!this.jsonObject.isNull(JSONMapping.ATTACHMENTS)) {
JSONArray fieldsArr = this.jsonObject.getJSONArray(
JSONMapping.ATTACHMENTS);
List assAttachments = new ArrayList();
for(int index = 0;index < fieldsArr.length();index++)
{
assAttachments.add(new Attachment(fieldsArr.getJSONObject(index)));
}
this.setAttachments(assAttachments);
}
//Form...
if (!this.jsonObject.isNull(JSONMapping.FORM)) {
this.setForm(new Form(this.jsonObject.getJSONObject(JSONMapping.FORM)));
}
//Flow...
if (!this.jsonObject.isNull(JSONMapping.FLOW)) {
this.setFlow(this.jsonObject.getString(JSONMapping.FLOW));
}
//Flow State...
if (!this.jsonObject.isNull(JSONMapping.FLOW_STATE)) {
this.setFlowStateString(this.jsonObject.getString(JSONMapping.FLOW_STATE));
}
}
/**
* Conversion to {@code JSONObject} from Java Object.
*
* @return {@code JSONObject} representation of {@code FluidItem}
* @throws JSONException If there is a problem with the JSON Body.
*
* @see ABaseFluidJSONObject#toJsonObject()
*/
@Override
public JSONObject toJsonObject() throws JSONException
{
JSONObject returnVal = super.toJsonObject();
//Flow...
if(this.getFlow() != null)
{
returnVal.put(JSONMapping.FLOW,this.getFlow());
}
//Form...
if(this.getForm() != null)
{
returnVal.put(JSONMapping.FORM,this.getForm().toJsonObject());
}
//User Fields...
if(this.getUserFields() != null && !this.getUserFields().isEmpty())
{
JSONArray fieldsArr = new JSONArray();
for(Field toAdd :this.getUserFields())
{
fieldsArr.put(toAdd.toJsonObject());
}
returnVal.put(JSONMapping.USER_FIELDS, fieldsArr);
}
//Route Fields...
if(this.getRouteFields() != null && !this.getRouteFields().isEmpty())
{
JSONArray fieldsArr = new JSONArray();
for(Field toAdd :this.getRouteFields())
{
fieldsArr.put(toAdd.toJsonObject());
}
returnVal.put(JSONMapping.ROUTE_FIELDS, fieldsArr);
}
//Global Fields...
if(this.getGlobalFields() != null && !this.getGlobalFields().isEmpty())
{
JSONArray fieldsArr = new JSONArray();
for(Field toAdd :this.getGlobalFields())
{
fieldsArr.put(toAdd.toJsonObject());
}
returnVal.put(JSONMapping.GLOBAL_FIELDS, fieldsArr);
}
//Attachments...
if(this.getAttachments() != null)
{
JSONArray jsonArray = new JSONArray();
for(Attachment toAdd : this.getAttachments())
{
jsonArray.put(toAdd.toJsonObject());
}
returnVal.put(JSONMapping.ATTACHMENTS, jsonArray);
}
//Flow State...
if(this.getFlowState() != null)
{
returnVal.put(JSONMapping.FLOW_STATE, this.getFlowState().toString());
}
return returnVal;
}
/**
*
* Returns the value of the {@code fieldNameParam} requested.
*
*
* The {@code fieldNameParam} is not case sensitive.
*
*
* A {@code null} will be returned if;
*
* - {@code fieldNameParam} is {@code null} or empty.
* - {@code getUserFields()} is {@code null} or empty.
* - Field is not found by {@code fieldNameParam}.
*
*
* @param fieldNameParam The name of the User Field as in Fluid.
* @return The value for the User Field as {@code String}.
*
* @see com.fluidbpm.program.api.vo.Field.Type#Text
*/
public String getUserFieldValueAsString(String fieldNameParam)
{
Object obj = this.getFieldValueForField(
fieldNameParam, this.getUserFields());
if(obj == null)
{
return null;
}
return obj.toString();
}
/**
*
* Returns the value of the {@code fieldNameParam} requested.
*
*
* The {@code fieldNameParam} is not case sensitive.
*
*
* A {@code null} will be returned if;
*
* - {@code fieldNameParam} is {@code null} or empty.
* - {@code getUserFields()} is {@code null} or empty.
* - Field is not found by {@code fieldNameParam}.
*
*
* @param fieldNameParam The name of the User Field as in Fluid.
* @return The value for the User Field as {@code Object}.
*
* @see com.fluidbpm.program.api.vo.Field.Type
*/
public Object getUserFieldValue(String fieldNameParam)
{
return this.getFieldValueForField(fieldNameParam, this.getUserFields());
}
/**
*
* Returns the value of the {@code fieldNameParam} requested.
*
*
* The {@code fieldNameParam} is not case sensitive.
*
*
* A {@code null} will be returned if;
*
* - {@code fieldNameParam} is {@code null} or empty.
* - {@code getUserFields()} is {@code null} or empty.
* - Field is not found by {@code fieldNameParam}.
*
*
* @param fieldNameParam The name of the Route Field as in Fluid.
* @return The value for the Route Field as {@code Object}.
*
* @see com.fluidbpm.program.api.vo.Field.Type
*/
public Object getRouteFieldValue(String fieldNameParam)
{
return this.getFieldValueForField(fieldNameParam, this.getRouteFields());
}
/**
*
* Returns the value of the {@code fieldNameParam} requested.
*
*
* The {@code fieldNameParam} is not case sensitive.
*
*
* A {@code null} will be returned if;
*
* - {@code fieldNameParam} is {@code null} or empty.
* - {@code getUserFields()} is {@code null} or empty.
* - Field is not found by {@code fieldNameParam}.
*
*
* @param fieldNameParam The name of the Global Field as in Fluid.
* @return The value for the Global Field as {@code Object}.
*
* @see com.fluidbpm.program.api.vo.Field.Type
*/
public Object getGlobalFieldValue(String fieldNameParam)
{
return this.getFieldValueForField(fieldNameParam,this.getGlobalFields());
}
/**
*
* Returns the value of the {@code fieldNameParam} requested.
*
*
* The {@code fieldNameParam} is not case sensitive.
*
*
* A {@code null} will be returned if;
*
* - {@code fieldNameParam} is {@code null} or empty.
* - {@code getUserFields()} is {@code null} or empty.
* - Field is not found by {@code fieldNameParam}.
*
*
* @param fieldNameParam The name of the Route Field as in Fluid.
* @return The value for the Route Field as {@code String}.
*
* @see com.fluidbpm.program.api.vo.Field.Type#Text
*/
public String getRouteFieldValueAsString(String fieldNameParam)
{
Object obj = this.getFieldValueForField(
fieldNameParam,this.getRouteFields());
if(obj == null)
{
return null;
}
return obj.toString();
}
/**
*
* Returns the value of the {@code fieldNameParam} requested.
*
*
* The {@code fieldNameParam} is not case sensitive.
*
*
* A {@code null} will be returned if;
*
* - {@code fieldNameParam} is {@code null} or empty.
* - {@code getUserFields()} is {@code null} or empty.
* - Field is not found by {@code fieldNameParam}.
*
*
* @param fieldNameParam The name of the Route Field as in Fluid.
* @return The value for the Route Field as {@code Double}.
*
* @see com.fluidbpm.program.api.vo.Field.Type#Decimal
*/
public Double getRouteFieldValueAsDouble(String fieldNameParam)
{
Object obj = this.getRouteFieldValue(fieldNameParam);
if(obj == null)
{
return null;
}
if(obj instanceof Number)
{
return ((Number)obj).doubleValue();
}
return null;
}
/**
*
* Returns the value of the {@code fieldNameParam} requested.
*
*
* The {@code fieldNameParam} is not case sensitive.
*
*
* A {@code null} will be returned if;
*
* - {@code fieldNameParam} is {@code null} or empty.
* - {@code getUserFields()} is {@code null} or empty.
* - Field is not found by {@code fieldNameParam}.
*
*
* @param fieldNameParam The name of the Global Field as in Fluid.
* @return The value for the Global Field as {@code String}.
*
* @see com.fluidbpm.program.api.vo.Field.Type#Text
*/
public String getGlobalFieldValueAsString(String fieldNameParam)
{
Object obj = this.getFieldValueForField(
fieldNameParam, this.getGlobalFields());
if(obj == null)
{
return null;
}
return obj.toString();
}
/**
*
* Returns the value of the {@code fieldNameParam} requested.
*
*
* The {@code fieldNameParam} is not case sensitive.
*
*
* A {@code null} will be returned if;
*
* - {@code fieldNameParam} is {@code null} or empty.
* - {@code getUserFields()} is {@code null} or empty.
* - Field is not found by {@code fieldNameParam}.
*
*
* @param fieldNameParam The name of the Global Field as in Fluid.
* @return The value for the Global Field as {@code Double}.
*
* @see com.fluidbpm.program.api.vo.Field.Type#Decimal
*/
public Double getGlobalFieldValueAsDouble(String fieldNameParam)
{
Object obj = this.getFieldValueForField(fieldNameParam, this.getGlobalFields());
if(obj == null)
{
return null;
}
if(obj instanceof Number)
{
return ((Number)obj).doubleValue();
}
return null;
}
/**
*
* Returns the value of the {@code fieldNameParam} requested.
*
*
* The {@code fieldNameParam} is not case sensitive.
*
*
* A {@code null} will be returned if;
*
* - {@code fieldNameParam} is {@code null} or empty.
* - {@code getUserFields()} is {@code null} or empty.
* - Field is not found by {@code fieldNameParam}.
*
*
* @param fieldNameParam The name of the Global Field as in Fluid.
* @return The value for the Global Field as {@code Integer}.
*
* @see com.fluidbpm.program.api.vo.Field.Type#Decimal
*/
public Integer getGlobalFieldValueAsInt(String fieldNameParam)
{
Object obj = this.getFieldValueForField(fieldNameParam,this.getGlobalFields());
if(obj == null)
{
return null;
}
if(obj instanceof Number)
{
return ((Number)obj).intValue();
}
return null;
}
/**
*
* Sets the value of the {@code fieldNameParam} requested.
*
* If there is an existing value, the value will be override with
* the value of {@code fieldValueParam}.
*
*
* The {@code fieldNameParam} is not case sensitive.
*
*
* The value won't be set if;
*
* - {@code fieldNameParam} is {@code null} or empty.
* - {@code getFormFields()} is {@code null} or empty.
* - Field is not found by {@code fieldNameParam}.
*
*
* @param fieldNameParam The name of the Global Field as in Fluid.
* @param fieldValueParam The value of the {@code Field}.
*
* @see com.fluidbpm.program.api.vo.Field.Type
*/
public void setGlobalFieldValue(String fieldNameParam, Object fieldValueParam)
{
if(fieldNameParam == null || fieldNameParam.trim().length() == 0)
{
return;
}
if(this.getGlobalFields() == null || this.getGlobalFields().isEmpty())
{
this.setGlobalFields(new ArrayList());
}
String fieldNameParamLower = fieldNameParam.toLowerCase();
boolean fieldFound = false;
for(Field field : this.getGlobalFields())
{
if(field.getFieldName() == null || field.getFieldName().trim().length() == 0)
{
continue;
}
String fieldNameLower = field.getFieldName().toLowerCase();
if(fieldNameParamLower.equals(fieldNameLower))
{
field.setFieldValue(fieldValueParam);
fieldFound = true;
break;
}
}
//When the Field is not added...
if(!fieldFound)
{
this.getGlobalFields().add(new Field(fieldNameParam,fieldValueParam));
}
}
/**
*
* Sets the value of the {@code fieldNameParam} requested.
*
* If there is an existing value, the value will be override with
* the value of {@code fieldValueParam}.
*
*
* The {@code fieldNameParam} is not case sensitive.
*
*
* The value won't be set if;
*
* - {@code fieldNameParam} is {@code null} or empty.
* - {@code getRouteFields()} is {@code null} or empty.
* - Field is not found by {@code fieldNameParam}.
*
*
* @param fieldNameParam The name of the Route Field as in Fluid.
* @param fieldValueParam The value of the {@code Field}.
* @param typeParam The {@code Field.Type} of {@code Field}.
*
* @see com.fluidbpm.program.api.vo.Field.Type
*/
public void setRouteFieldValue(String fieldNameParam, Object fieldValueParam, Field.Type typeParam) {
if (fieldNameParam == null) {
return;
}
if (this.routeFields == null) {
this.routeFields = new ArrayList();
}
String paramLower = fieldNameParam.toLowerCase().trim();
boolean valueFound = false;
//Iterate the Route Fields...
for (Field existingField : this.routeFields) {
String toCheckNameLower = existingField.getFieldName();
if (toCheckNameLower == null || toCheckNameLower.trim().isEmpty()) {
continue;
}
toCheckNameLower = toCheckNameLower.trim().toLowerCase();
if (paramLower.equals(toCheckNameLower)) {
valueFound = true;
existingField.setTypeAsEnum(typeParam);
existingField.setFieldValue(fieldValueParam);
break;
}
}
if (!valueFound) {
this.routeFields.add(new Field(fieldNameParam, fieldValueParam, typeParam));
}
}
/**
*
* Sets the value of the {@code fieldNameParam} requested.
*
* If there is an existing value, the value will be override with
* the value of {@code fieldValueParam}.
*
*
* The {@code fieldNameParam} is not case sensitive.
*
*
* The value won't be set if;
*
* - {@code fieldNameParam} is {@code null} or empty.
* - {@code getFormFields()} is {@code null} or empty.
* - Field is not found by {@code fieldNameParam}.
*
*
* @param fieldNameParam The name of the Global Field as in Fluid.
* @param fieldValueParam The value of the {@code Field}.
* @param typeParam The {@code Field.Type} of {@code Field}.
*
* @see com.fluidbpm.program.api.vo.Field.Type
*/
public void setGlobalFieldValue(String fieldNameParam, Object fieldValueParam, Field.Type typeParam) {
if (fieldNameParam == null) {
return;
}
if (this.getGlobalFields() == null || this.getGlobalFields().isEmpty()) {
this.setGlobalFields(new ArrayList());
}
String paramLower = fieldNameParam.toLowerCase().trim();
boolean valueFound = false;
//Iterate the Form Fields...
int fieldIndex = -1;
for (Field field : this.getGlobalFields()) {
fieldIndex++;
String toCheckNameLower = field.getFieldName();
if (toCheckNameLower == null || toCheckNameLower.trim().isEmpty()) {
continue;
}
toCheckNameLower = toCheckNameLower.trim().toLowerCase();
if (paramLower.equals(toCheckNameLower)) {
valueFound = true;
this.getGlobalFields().get(fieldIndex).setFieldValue(fieldValueParam);
this.getGlobalFields().get(fieldIndex).setTypeAsEnum(typeParam);
break;
}
}
if (!valueFound) {
this.getGlobalFields().add(new Field(fieldNameParam, fieldValueParam, typeParam));
}
}
/**
*
* Returns the value of the {@code fieldNameParam} requested.
*
*
* The {@code fieldNameParam} is not case sensitive.
*
*
* A {@code null} will be returned if;
*
* - {@code fieldNameParam} is {@code null} or empty.
* - {@code getUserFields()} is {@code null} or empty.
* - {@code toGetPropertyFromParam} is {@code null} or empty.
* - Field is not found by {@code fieldNameParam}.
*
*
* @param fieldNameParam The name of the Global Field as in Fluid.
* @param toGetPropertyFromParam The {@code List} where the value
* will be retrieved from.
*
* @return The value for the Field as {@code Object}.
*
* @see Field
*/
public Object getFieldValueForField(
String fieldNameParam, List toGetPropertyFromParam) {
if (fieldNameParam == null || fieldNameParam.trim().isEmpty()) {
return null;
}
if (toGetPropertyFromParam == null || toGetPropertyFromParam.isEmpty()) {
return null;
}
String fieldNameParamLower = fieldNameParam.trim().toLowerCase();
for (Field field : toGetPropertyFromParam) {
String fieldName = field.getFieldName();
if (fieldName == null || fieldName.trim().isEmpty()) {
continue;
}
String fieldNameLower = fieldName.trim().toLowerCase();
if (fieldNameParamLower.equals(fieldNameLower)) {
return field.getFieldValue();
}
}
return null;
}
/**
* Gets the attachments.
*
* @return {@code List} of attachments.
*
* @see Attachment
*/
public List getAttachments() {
return this.attachments;
}
/**
* Sets the attachments.
*
* @param attachmentsParam {@code List} of attachments.
*/
public void setAttachments(List attachmentsParam) {
this.attachments = attachmentsParam;
}
/**
* Adds {@code toAddParam} to the list of {@code Attachment}s.
*
* @param toAddParam {@code Attachment} to add.
*
* @see Attachment
*/
public void addAttachment(Attachment toAddParam) {
if (!this.containsAttachments()) {
this.setAttachments(new ArrayList());
}
this.getAttachments().add(toAddParam);
}
/**
* Gets all the {@code User} {@code Field}s.
*
* @return All the User Fields.
*
* @see Field
*/
public List getUserFields() {
return this.userFields;
}
/**
* Sets all the {@code User}{@code Field}s.
*
* @param userFieldsParam The new {@code User}{@code Field}s.
*
* @see Field
*/
public void setUserFields(List userFieldsParam) {
this.userFields = userFieldsParam;
}
/**
* Gets all the {@code Route} {@code Field}s.
*
* @return All the Route Fields.
*
* @see Field
*/
public List getRouteFields() {
return this.routeFields;
}
/**
* Sets all the {@code Route}{@code Field}s.
*
* @param routeFieldsParam The new {@code Route}{@code Field}s.
*
* @see Field
*/
public void setRouteFields(List routeFieldsParam) {
this.routeFields = routeFieldsParam;
}
/**
* Sets all the {@code Route}{@code Field}s.
*
* @param routeFieldsParam The new {@code Route}{@code Field}s.
*
* @see Field
*/
@XmlTransient
public void setRouteFieldsArrayList(ArrayList routeFieldsParam) {
this.routeFields = routeFieldsParam;
}
/**
* Gets all the {@code Global} {@code Field}s.
*
* @return All the Global Fields.
*
* @see Field
*/
public List getGlobalFields() {
return this.globalFields;
}
/**
* Sets all the {@code Global}{@code Field}s.
*
* @param globalFieldsParam The new {@code Global}{@code Field}s.
*
* @see Field
*/
public void setGlobalFields(List globalFieldsParam) {
this.globalFields = globalFieldsParam;
}
/**
* Gets the Form for {@code this}
*
* @return {@code Form} associated with the {@code FluidItem}.
*/
public Form getForm() {
return this.form;
}
/**
* Sets the Form for {@code this}
*
* @param formParam {@code Form} associated with the {@code FluidItem}.
*/
public void setForm(Form formParam) {
this.form = formParam;
}
/**
* Gets the {@code FlowState}.
*
* @return {@code FlowState} for {@code this} {@code FluidItem}
*
* @see FlowState
*/
public FlowState getFlowState() {
return this.flowState;
}
/**
* Sets the {@code FlowState}.
*
* @param flowStateParam {@code FlowState} for {@code this} {@code FluidItem}
*
* @see FlowState
*/
public void setFlowState(FlowState flowStateParam) {
this.flowState = flowStateParam;
}
/**
* Sets the {@code FlowState}.
*
* @param flowStateParam {@code FlowState} for {@code this} {@code FluidItem}
*
* @see FlowState
*/
@XmlTransient
public void setFlowStateString(String flowStateParam) {
this.flowState = FlowState.valueOfSafe(flowStateParam);
}
/**
* Checks whether the {@code getAttachments()} is empty.
*
* @return If the list of attachments is empty.
*/
public boolean containsAttachments() {
return (this.attachments != null && !this.attachments.isEmpty());
}
/**
* Gets the {@code Flow} the {@code FluidItem} is associated with.
*
* @return Name of the {@code Flow}.
*
* @see com.fluidbpm.program.api.vo.flow.Flow
*/
public String getFlow() {
return this.flow;
}
/**
* Sets the {@code Flow} the {@code FluidItem} is associated with.
*
* @param flowParam Name of the {@code Flow}.
*
* @see com.fluidbpm.program.api.vo.flow.Flow
*/
public void setFlow(String flowParam) {
this.flow = flowParam;
}
/**
* If {@code this} is a newly created {@code FluidItem} as part of the
* {@code Flow} {@code ICustomProgram}. This will be used as a "flag" to
* make {@code this} {@code FluidItem} a descendant for the "parent"
* {@code FluidItem}.
*
* @return Whether {@code this} {@code FluidItem} should be linked to the "parent"
*
* @see Form
* @see com.fluidbpm.program.api.ICustomProgram
*/
public Boolean getInCaseOfCreateLinkToParent() {
return this.inCaseOfCreateLinkToParent;
}
/**
* If {@code this} is a newly created {@code FluidItem} as part of the
* {@code Flow} {@code ICustomProgram}. This will be used as a "flag" to
* make {@code this} {@code FluidItem} a descendant for the "parent"
* {@code FluidItem}.
*
* @param inCaseOfCreateLinkToParentParam Whether {@code this} {@code FluidItem} should be linked to the "parent"
*
* @see Form
* @see com.fluidbpm.program.api.ICustomProgram
*/
public void setInCaseOfCreateLinkToParent(Boolean inCaseOfCreateLinkToParentParam) {
this.inCaseOfCreateLinkToParent = inCaseOfCreateLinkToParentParam;
}
/**
* If {@code this} {@code FluidItem.getForm} is a {@code Field.Type.Table} {@code Field},
* the parent {@code Form} / Electronic Form needs to be set to indicate which {@code Form} is
* the container {@code Form}.
*
* @return The Table containing {@code Form}.
*
* @see com.fluidbpm.program.api.vo.Field.Type#Table
* @see Form
*/
public Form getTableFieldParentForm() {
return this.tableFieldParentForm;
}
/**
* If {@code this} {@code FluidItem.getForm} is a {@code Field.Type.Table} {@code Field},
* the parent {@code Form} / Electronic Form needs to be set to indicate which {@code Form} is
* the container {@code Form}.
*
* @param tableFieldParentFormParam The Table containing {@code Form}.
*
* @see com.fluidbpm.program.api.vo.Field.Type#Table
* @see Form
*/
public void setTableFieldParentForm(Form tableFieldParentFormParam) {
this.tableFieldParentForm = tableFieldParentFormParam;
}
/**
* If {@code this} {@code TableFieldParentForm} is set.
* The name of the {@code Field.Type.Table} {@code Field} also needs to be
* provided.
*
* Sets the name of the Table Field.
*
* @return The Table containing {@code Form}.
*
* @see com.fluidbpm.program.api.vo.Field.Type#Table
* @see Form
*/
public String getTableFieldNameOnParentForm() {
return this.tableFieldNameOnParentForm;
}
/**
* If {@code this} {@code TableFieldParentForm} is set.
* The name of the {@code Field.Type.Table} {@code Field} also needs to be
* provided.
*
* Sets the name of the Table Field.
*
* @param tableFieldNameParam The Table containing {@code Form}.
*
* @see com.fluidbpm.program.api.vo.Field.Type#Table
* @see Form
*/
public void setTableFieldNameOnParentForm(String tableFieldNameParam) {
this.tableFieldNameOnParentForm = tableFieldNameParam;
}
}