Package nl.gx.forms.wmpformapi.api.form
Interface FormCategory
-
- All Superinterfaces:
Identifiable
public interface FormCategory extends Identifiable
Form categories can be used to order forms.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WorkflowModel
getCustomWorkflowModel()
Returns theWorkflowModel
for this category, ornull
if inherited.List<Form>
getForms()
Returns a list of forms that have this category.List<FormSection>
getFormSections()
Returns a list of form sections that have this category.String
getTitle()
The title of this category.int
getWebsiteId()
The website id this form category belongs to.WorkflowModel
getWorkflowModel()
Returns theWorkflowModel
for this category.void
setCustomWorkflowModel(WorkflowModel workflowModel)
Sets theWorkflowModel
in the workflowModel parameter on thisFormCategory
.void
setTitle(String title)
Sets or updates the title of this category.void
setWebsiteId(int websiteId)
Sets the website id for this category.-
Methods inherited from interface nl.gx.webmanager.services.entitymanager.Identifiable
getId, setId
-
-
-
-
Method Detail
-
getWebsiteId
int getWebsiteId()
The website id this form category belongs to.- Returns:
- The website id this form category belongs to.
-
setWebsiteId
void setWebsiteId(int websiteId)
Sets the website id for this category.- Parameters:
websiteId
- The website id for this category.
-
getTitle
String getTitle()
The title of this category.- Returns:
- The title of this category.
-
setTitle
void setTitle(String title)
Sets or updates the title of this category.- Parameters:
title
- the new title.
-
getForms
List<Form> getForms()
Returns a list of forms that have this category. Note that not all forms have a category.- Returns:
- The list of all forms in this category.
-
getFormSections
List<FormSection> getFormSections()
Returns a list of form sections that have this category. Note that not all form sections have a category.- Returns:
- The list of all form sections in this category.
-
getCustomWorkflowModel
WorkflowModel getCustomWorkflowModel()
Returns theWorkflowModel
for this category, ornull
if inherited.- Returns:
- the
WorkflowModel
for this category, ornull
if inherited - See Also:
getWorkflowModel()
-
setCustomWorkflowModel
void setCustomWorkflowModel(WorkflowModel workflowModel)
Sets theWorkflowModel
in the workflowModel parameter on thisFormCategory
.- Parameters:
workflowModel
- theWorkflowModel
which is set on thisFormCategory
ornull
to inherit theWorkflowModel
-
getWorkflowModel
WorkflowModel getWorkflowModel()
Returns theWorkflowModel
for this category. If inherited the inheritedWorkflowModel
is returned.- Returns:
- the
WorkflowModel
for this category - See Also:
getCustomWorkflowModel()
-
-