org.jbpm.form.builder.services.api
public interface FormBuilderService
Modifier and Type | Interface and Description |
---|---|
static interface |
FormBuilderService.RolesResponseHandler |
Modifier and Type | Method and Description |
---|---|
void |
applySettings(Settings settings) |
void |
deleteFile(String url) |
void |
deleteForm(FormRepresentation form)
Deletes a form from the server
|
void |
deleteFormItem(String formItemName,
FormItemRepresentation formItem)
Deletes a UI component from the server
|
void |
generateForm(FormRepresentation form,
String language,
Map<String,Object> inputs)
Translates a form.
|
void |
getCurrentRoles(FormBuilderService.RolesResponseHandler handler) |
void |
getExistingIoAssociations(String filter)
Returns the IoAssociations as matching on a simple string filter
|
void |
getExistingValidations()
Returns existing validations from the server
|
void |
getForm(String formName)
Returns a single form
|
String |
getFormDisplay() |
void |
getForms()
Returns all forms
|
void |
getMenuItems()
Gets a map of groups indexed by group name.
|
void |
getMenuOptions()
Gets a list of menu options, generally for a menu bar.
|
String |
getUploadActionURL() |
String |
getUploadFileURL() |
FormRepresentation |
loadForm(String json) |
void |
loadFormTemplate(FormRepresentation form,
String language)
Loads a file from the server that contains a given language's form template
|
void |
loadSettings() |
void |
logout() |
void |
populateRepresentationFactory()
Populates the
RepresentationFactory with the form items and representations
that belong to them. |
String |
saveForm(FormRepresentation form)
Saves a form on the server
|
void |
saveFormItem(FormItemRepresentation formItem,
String formItemName)
Saves a UI component on the server
|
void |
selectIoAssociation(String pkgName,
String processName,
String taskName)
Fires a TaskSelectedEvent in case you can find the proper task in the server
|
void |
setPackageName(String packageName) |
void getMenuItems() throws FormBuilderServiceException
FormBuilderException
- in case of error.FormBuilderServiceException
void getMenuOptions() throws FormBuilderServiceException
FormBuilderException
- in case of error.FormBuilderServiceException
String saveForm(FormRepresentation form) throws FormBuilderServiceException
form
- The form to be savedFormBuilderException
- in case of errorFormBuilderServiceException
void saveFormItem(FormItemRepresentation formItem, String formItemName) throws FormBuilderServiceException
formItem
- the UI component to be savedformItemName
- the UI component nameFormBuilderException
- in case of errorFormBuilderServiceException
void deleteForm(FormRepresentation form) throws FormBuilderServiceException
form
- The form to be deletedFormBuilderException
- in case of errorFormBuilderServiceException
void deleteFile(String url) throws FormBuilderServiceException
FormBuilderServiceException
void deleteFormItem(String formItemName, FormItemRepresentation formItem) throws FormBuilderServiceException
formItemName
- The UI component nameformItem
- the UI component to be deletedFormBuilderException
- in case of errorFormBuilderServiceException
void generateForm(FormRepresentation form, String language, Map<String,Object> inputs) throws FormBuilderServiceException
form
- Form to be translatedlanguage
- Language to translate the formFormBuilderException
- in case of errorFormBuilderServiceException
void getExistingIoAssociations(String filter) throws FormBuilderServiceException
filter
- a filter for a google-like search textfieldFormBuilderException
- in case of errorFormBuilderServiceException
void selectIoAssociation(String pkgName, String processName, String taskName) throws FormBuilderServiceException
pkgName
- the name of the packageprocessName
- the name of the processtaskName
- the name of the taskFormBuilderException
- in case of errorFormBuilderServiceException
void getExistingValidations() throws FormBuilderServiceException
FormBuilderException
- in case of errorFormBuilderServiceException
void getForm(String formName) throws FormBuilderServiceException
formName
- the name of the form to be returnedFormBuilderException
- in case of error.FormBuilderServiceException
void getForms() throws FormBuilderServiceException
FormBuilderException
- in case of error.FormBuilderServiceException
void populateRepresentationFactory() throws FormBuilderServiceException
RepresentationFactory
with the form items and representations
that belong to them.callback
- callback to tell the client what to do once it finishesFormBuilderException
- in case of error.FormBuilderServiceException
void loadFormTemplate(FormRepresentation form, String language) throws FormBuilderServiceException
form
- the form representation to create a template fromlanguage
- the result template expected languageFormBuilderException
- in case of error.FormBuilderServiceException
FormRepresentation loadForm(String json)
void getCurrentRoles(FormBuilderService.RolesResponseHandler handler) throws FormBuilderServiceException
FormBuilderServiceException
String getUploadFileURL()
String getUploadActionURL()
void setPackageName(String packageName)
void logout()
void applySettings(Settings settings)
void loadSettings()
String getFormDisplay()
Copyright © 2001-2013 JBoss by Red Hat. All Rights Reserved.