com.fluidbpm.program.api.util.IFormAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fluid-api Show documentation

Used for the * Custom Program Step, * Custom Actions, * Scheduled Actions and * Fluid API in the Fluid BPM and Content Management system.

There is a newer version: 1.12

Show newest version

/*
 * Koekiebox CONFIDENTIAL
 *
 * [2012] - [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.util;

import java.util.List;

import com.fluidbpm.program.api.vo.Form;

/**
 * Any form related actions.
 *
 * @author jasonbruwer on 2016/11/11.
 * @since 1.0
 */
public interface IFormAction extends IAction {

    /**
     * Gets the ancestor for the {@code electronicFormIdParam} Form.
     *
     * @param electronicFormIdParam Identifier for the Form.
     * @param includeFieldDataParam Whether to populate the return {@code Form} fields.
     * @param includeTableFieldsParam Whether to populate the return {@code Form} table fields.
     *
     * @return {@code Form} descendants.
     *
     * @see Form
     */
    public abstract Form getFormAncestor(
            Long electronicFormIdParam,
            boolean includeFieldDataParam,
            boolean includeTableFieldsParam);

    /**
     * Retrieves the Table field records as {@code List}.
     *
     * @param electronicFormIdParam The Form Identifier.
     * @param includeFieldDataParam Whether to populate the return {@code List} fields.
     * @return {@code List} records.
     */
    public List getFormTableForms(
            Long electronicFormIdParam,
            boolean includeFieldDataParam);

    /**
     * Gets the descendants for the {@code electronicFormIdParam} Form.
     *
     * @param electronicFormIdParam Identifier for the Form.
     * @param includeFieldDataParam Whether to populate the return {@code List} fields.
     * @param includeTableFieldsParam Whether to populate the return {@code List} table fields.
     * @return {@code List} descendants.
     *
     * @see Form
     */
    public List getFormDescendants(
            Long electronicFormIdParam,
            boolean includeFieldDataParam,
            boolean includeTableFieldsParam);

    /**
     * Gets the descendants for the {@code electronicFormIdsParam} Forms.
     *
     * @param electronicFormIdsParam Identifiers for the Forms to retrieve.
     * @param includeFieldDataParam Whether to populate the return {@code List} fields.
     * @param includeTableFieldsParam Whether to populate the return {@code List} table fields.
     * @return {@code List} descendants.
     *
     * @see Form
     */
    public List getFormDescendants(
            List electronicFormIdsParam,
            boolean includeFieldDataParam,
            boolean includeTableFieldsParam);
}