Package com.axemble.vdoc.sdk.impl

Class ProcessFieldController

java.lang.Object
com.axemble.vdoc.sdk.impl.AbstractElement
com.axemble.vdoc.sdk.impl.ProcessFieldController
All Implemented Interfaces:
IController, IFieldController, Serializable
public class ProcessFieldController extends AbstractElement implements IFieldController
Manage fields in process (in workflows, data universe)
See Also:

  • Constructor Details

    • ProcessFieldController

      protected ProcessFieldController(IModule module, com.axemble.vdoc.core.domain.BaseDomain definitionObject)

  • Method Details

    • createTextField

      public IProperty createTextField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple, boolean createList)
      Description copied from interface: IFieldController
      Create a text field
      Specified by:
      createTextField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      createList - true to create a list associated to the field (only if it is multiple)
      Returns:
      the created field

    • createMultilingualTextField

      public IProperty createMultilingualTextField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Description copied from interface: IFieldController
      Create a multilingual text field
      Specified by:
      createMultilingualTextField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      Returns:
      the created field

    • createIntegerField

      public IProperty createIntegerField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Description copied from interface: IFieldController
      Create an integer field
      Specified by:
      createIntegerField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      Returns:
      the created field

    • createDoubleField

      public IProperty createDoubleField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Description copied from interface: IFieldController
      Create a double field
      Specified by:
      createDoubleField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      Returns:
      the created field

    • createLongField

      public IProperty createLongField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Description copied from interface: IFieldController
      Create a long field
      Specified by:
      createLongField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      Returns:
      the created field

    • createFloatField

      public IProperty createFloatField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Description copied from interface: IFieldController
      Create a float field
      Specified by:
      createFloatField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      Returns:
      the created field

    • createBooleanField

      public IProperty createBooleanField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Description copied from interface: IFieldController
      Create a boolean field
      Specified by:
      createBooleanField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      Returns:
      the created field

    • createDateField

      public IProperty createDateField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Description copied from interface: IFieldController
      Create a date field
      Specified by:
      createDateField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      Returns:
      the created field

    • createPeriodField

      public IProperty createPeriodField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Description copied from interface: IFieldController
      Create a period field
      Specified by:
      createPeriodField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      Returns:
      the created field

    • createExternalElementField

      public IProperty createExternalElementField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Description copied from interface: IFieldController
      Create an external element field
      Specified by:
      createExternalElementField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      Returns:
      the created field

    • createAttachmentField

      public IProperty createAttachmentField(Map<String,String> labels, Map<String,String> descriptions, String name)
      Description copied from interface: IFieldController
      Create an attachment field (necessarily multiple)
      Specified by:
      createAttachmentField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      Returns:
      the created field

    • createUserField

      public IProperty createUserField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Description copied from interface: IFieldController
      Create a user field
      Specified by:
      createUserField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      Returns:
      the created field

    • createGroupField

      public IProperty createGroupField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Description copied from interface: IFieldController
      Create a group field
      Specified by:
      createGroupField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      Returns:
      the created field

    • createOrganizationField

      public IProperty createOrganizationField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Description copied from interface: IFieldController
      Create an organization field
      Specified by:
      createOrganizationField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      Returns:
      the created field

    • createLocalizationField

      public IProperty createLocalizationField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Description copied from interface: IFieldController
      Create a localization field
      Specified by:
      createLocalizationField in interface IFieldController
      Parameters:
      labels - a map that contains the language in the key (fr, en, ...) and the label in the value
      descriptions - a map that contains the language in the key (fr, en, ...) and the description in the value
      name - the field name
      isMultiple - true if the field contains a collection of value
      Returns:
      the created field

    • linkFieldToWorkflow

      public void linkFieldToWorkflow(IContext context, IProperty property)
      Description copied from interface: IFieldController
      Link an existing field to the controller's definitionObject (mist be a workflow) The property must exist in the workflow's catalog !
      Specified by:
      linkFieldToWorkflow in interface IFieldController
      Parameters:
      context - the execution context
      property - the field to link

    • retrieveField

      public IProperty retrieveField(String name)
      Description copied from interface: IFieldController
      Retrieve the field of the catalog/workflow/resource by its name
      Specified by:
      retrieveField in interface IFieldController
      Parameters:
      name - the field's name
      Returns:
      the field if it exists, null if not