jbpm-form-modeler-api 6.0.0.Beta5

org.jbpm.formModeler.core.config
Interface FormManager

All Superinterfaces:
Serializable

public interface FormManager
extends Serializable

Manager interface form Forms.

It provides the common operations over Forms (creation, edit, delete) and distinct search methods.


Field Summary
static int FORMSTATUS_HIDDEN
           
static int FORMSTATUS_NORMAL
           
 
Method Summary
 Field addFieldToForm(Form pForm, FieldType fieldType)
           
 Field addFieldToForm(Form pForm, String fieldName, FieldType fieldType, I18nSet label)
           
 Field addFieldToForm(Form pForm, String fieldName, FieldType fieldType, I18nSet label, String inputBindingString, String outputBindingString)
           
 void changeFieldPosition(Form pForm, int fieldPos, int destPos, boolean groupWithPrevious, boolean nextFieldGrouped)
           
 Form cloneForm(Form source)
           
 Form cloneForm(Long id)
           
 Form createForm(String name)
           
 Form createForm(String subject, String name, String displayMode, Long status)
           
 void degradeField(Form pForm, int fieldPos, int destPos, boolean groupWithPrevious, boolean nextFieldGrouped)
           
 void deleteField(Form pForm, int fieldPos)
           
 void deleteForm(Form pForm)
           
 Form duplicateForm(Long duplicateId, String name, String displayMode, Long status)
           
 Form[] getAllForms()
           
 Form getFormById(Long id)
           
 Form getFormForFieldEdition(FieldType fieldType)
           
 List<Form> getFormsBySubject(String subject)
           
 List<Form> getFormsBySubjectAndName(String subject, String name)
           
 String getUniqueIdentifier(Form form, String namespace, Field field, String fieldName)
           
 String getUniqueIdentifiersPreffix()
           
 void groupWithPrevious(Form pForm, int fieldPos, boolean value)
           
 void moveBottom(Form pForm, int fieldPos)
           
 boolean moveDown(Form pForm, int fieldPos)
           
 void moveTop(Form pForm, int fieldPos)
           
 boolean moveUp(Form pForm, int fieldPos)
           
 void promoteField(Form pForm, int fieldPos, int destPos, boolean groupWithPrevious, boolean nextFieldGrouped)
           
 void replaceForm(Form source, Form dest)
           
 void replaceForm(Long sourceId, Form dest)
           
 void saveTemplateForForm(Long formId, String templateContent)
           
 

Field Detail

FORMSTATUS_NORMAL

static final int FORMSTATUS_NORMAL
See Also:
Constant Field Values

FORMSTATUS_HIDDEN

static final int FORMSTATUS_HIDDEN
See Also:
Constant Field Values
Method Detail

getFormsBySubject

List<Form> getFormsBySubject(String subject)
                             throws Exception
Throws:
Exception

getFormsBySubjectAndName

List<Form> getFormsBySubjectAndName(String subject,
                                    String name)
                                    throws Exception
Throws:
Exception

getAllForms

Form[] getAllForms()

getFormForFieldEdition

Form getFormForFieldEdition(FieldType fieldType)
                            throws Exception
Throws:
Exception

getFormById

Form getFormById(Long id)

createForm

Form createForm(String name)

createForm

Form createForm(String subject,
                String name,
                String displayMode,
                Long status)

cloneForm

Form cloneForm(Long id)

cloneForm

Form cloneForm(Form source)
               throws Exception
Throws:
Exception

duplicateForm

Form duplicateForm(Long duplicateId,
                   String name,
                   String displayMode,
                   Long status)
                   throws Exception
Throws:
Exception

replaceForm

void replaceForm(Long sourceId,
                 Form dest)

replaceForm

void replaceForm(Form source,
                 Form dest)

deleteForm

void deleteForm(Form pForm)
                throws Exception
Throws:
Exception

addFieldToForm

Field addFieldToForm(Form pForm,
                     FieldType fieldType)
                     throws Exception
Throws:
Exception

addFieldToForm

Field addFieldToForm(Form pForm,
                     String fieldName,
                     FieldType fieldType,
                     I18nSet label)
                     throws Exception
Throws:
Exception

addFieldToForm

Field addFieldToForm(Form pForm,
                     String fieldName,
                     FieldType fieldType,
                     I18nSet label,
                     String inputBindingString,
                     String outputBindingString)
                     throws Exception
Throws:
Exception

promoteField

void promoteField(Form pForm,
                  int fieldPos,
                  int destPos,
                  boolean groupWithPrevious,
                  boolean nextFieldGrouped)
                  throws Exception
Throws:
Exception

degradeField

void degradeField(Form pForm,
                  int fieldPos,
                  int destPos,
                  boolean groupWithPrevious,
                  boolean nextFieldGrouped)
                  throws Exception
Throws:
Exception

changeFieldPosition

void changeFieldPosition(Form pForm,
                         int fieldPos,
                         int destPos,
                         boolean groupWithPrevious,
                         boolean nextFieldGrouped)
                         throws Exception
Throws:
Exception

moveTop

void moveTop(Form pForm,
             int fieldPos)
             throws Exception
Throws:
Exception

moveBottom

void moveBottom(Form pForm,
                int fieldPos)
                throws Exception
Throws:
Exception

moveUp

boolean moveUp(Form pForm,
               int fieldPos)
               throws Exception
Throws:
Exception

groupWithPrevious

void groupWithPrevious(Form pForm,
                       int fieldPos,
                       boolean value)
                       throws Exception
Throws:
Exception

moveDown

boolean moveDown(Form pForm,
                 int fieldPos)
                 throws Exception
Throws:
Exception

deleteField

void deleteField(Form pForm,
                 int fieldPos)
                 throws Exception
Throws:
Exception

saveTemplateForForm

void saveTemplateForForm(Long formId,
                         String templateContent)
                         throws Exception
Throws:
Exception

getUniqueIdentifiersPreffix

String getUniqueIdentifiersPreffix()

getUniqueIdentifier

String getUniqueIdentifier(Form form,
                           String namespace,
                           Field field,
                           String fieldName)

jbpm-form-modeler-api 6.0.0.Beta5

Copyright © 2001-2013 JBoss by Red Hat. All Rights Reserved.