Package com.axemble.vdoc.sdk.interfaces

Interface IFieldController

All Superinterfaces:
IController, Serializable
All Known Implementing Classes:
ProcessFieldController
public interface IFieldController extends IController
Help to manage fields in a Process workflow opr data universe

  • Method Details

    • createTextField

      IProperty createTextField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple, boolean createList)
      Create a text field
      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

      IProperty createMultilingualTextField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Create a multilingual text field
      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

      IProperty createIntegerField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Create an integer field
      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

      IProperty createDoubleField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Create a double field
      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

      IProperty createLongField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Create a long field
      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

      IProperty createFloatField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Create a float field
      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

      IProperty createBooleanField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Create a boolean field
      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

      IProperty createDateField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Create a date field
      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

      IProperty createPeriodField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Create a period field
      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

      IProperty createExternalElementField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Create an external element field
      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

      IProperty createAttachmentField(Map<String,String> labels, Map<String,String> descriptions, String name)
      Create an attachment field (necessarily multiple)
      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

      IProperty createUserField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Create a user field
      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

      IProperty createGroupField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Create a group field
      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

      IProperty createOrganizationField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Create an organization field
      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

      IProperty createLocalizationField(Map<String,String> labels, Map<String,String> descriptions, String name, boolean isMultiple)
      Create a localization field
      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

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

    • retrieveField

      IProperty retrieveField(String name)
      Retrieve the field of the catalog/workflow/resource by its name
      Parameters:
      name - the field's name
      Returns:
      the field if it exists, null if not