Package com.avoka.fc.core.entity

Class ServiceParameter

java.lang.Object
org.apache.cayenne.PersistentObject
org.apache.cayenne.BaseDataObject
org.apache.cayenne.CayenneDataObject
com.avoka.core.entity.BaseEntity
com.avoka.fc.core.entity.auto._ServiceParameter
com.avoka.fc.core.entity.ServiceParameter
All Implemented Interfaces:
IEntity, Auditable, Serializable, org.apache.cayenne.DataObject, org.apache.cayenne.Persistent, org.apache.cayenne.Validating
@CacheGroups("CONFIG") public class ServiceParameter extends _ServiceParameter implements Auditable
Provides a typed parameter used to configure a service.
See Also:

  • Field Details

    • GROOVY_SCRIPT_PARAMETER

      public static final String GROOVY_SCRIPT_PARAMETER
      The 'groovyScript' parameter name.
      See Also:

    • UNIT_TEST_SCRIPT_PARAMETER

      public static final String UNIT_TEST_SCRIPT_PARAMETER
      The 'Unit Test Script' parameter name.
      See Also:

    • TEST_SUITE_SERVICES

      public static final String TEST_SUITE_SERVICES
      The 'Test Suite Services' parameter name.
      See Also:

    • REST_INVOKE_ENABLED

      public static final String REST_INVOKE_ENABLED
      The 'REST Invoke Enabled' parameter name.
      See Also:

    • TEST_EMAIL_NOTIFICATIONS

      public static final String TEST_EMAIL_NOTIFICATIONS
      The 'Email Notifications' parameter name.
      See Also:

    • TEST_EMAIL_ADDRESSES

      public static final String TEST_EMAIL_ADDRESSES
      The 'Email Addresses' parameter name.
      See Also:

    • EVENT_CONFIGURATION_PARAMETER

      public static final String EVENT_CONFIGURATION_PARAMETER
      The 'Event Configuration' parameter name.
      See Also:

    • HELP_DOC_PARAMETER

      public static final String HELP_DOC_PARAMETER
      The 'Help Doc' parameter name.
      See Also:

    • JOB_DEFINITION_PARAMETER

      public static final String JOB_DEFINITION_PARAMETER
      The 'jobDefinition' parameter name.
      See Also:

    • FORM_PROPERTY_EDITOR_DEFINITION_PARAMETER

      public static final String FORM_PROPERTY_EDITOR_DEFINITION_PARAMETER
      The 'Form Property Editor Definition' parameter name.
      See Also:

    • TYPE_BOOLEAN

      public static final String TYPE_BOOLEAN
      Indicates that the parameter can accept the values "true" and "false"
      See Also:

    • TYPE_DATE

      public static final String TYPE_DATE
      Indicates that the parameter can accept date values
      See Also:

    • TYPE_EMAIL

      public static final String TYPE_EMAIL
      Indicates that the parameter can accept a valid email address
      See Also:

    • TYPE_GROOVY_SCRIPT

      public static final String TYPE_GROOVY_SCRIPT
      Indicates that the parameter can accept Groovy script
      See Also:

    • TYPE_HTML

      public static final String TYPE_HTML
      Indicates that the parameter can accept HTML values
      See Also:

    • TYPE_JSON

      public static final String TYPE_JSON
      Indicates that the parameter can accept JSON values
      See Also:

    • TYPE_LIST

      public static final String TYPE_LIST
      Indicates that the parameter can accept a value from a pre-defined list
      See Also:

    • TYPE_NUMBER

      public static final String TYPE_NUMBER
      Indicates that the parameter can accept numeric values
      See Also:

    • TYPE_STRING

      public static final String TYPE_STRING
      Indicates that the parameter can accept string values
      See Also:

    • TYPE_PASSWORD

      public static final String TYPE_PASSWORD
      Indicates that the parameter can accept password values
      See Also:

    • TYPES

      public static final String[] TYPES
      The full set of possible data types

    • DATE_FORMAT_PATTERN

      public static final String DATE_FORMAT_PATTERN
      The format pattern used when storing service parameters of type date
      See Also:

  • Constructor Details

    • ServiceParameter

      public ServiceParameter()

  • Method Details

    • getListValuesMap

      public Map<String,String> getListValuesMap()
      Return the values for a list parameter. Each entry has a value and a display string.
      Returns:
      the map containing all list values
      Throws:
      RuntimeException - if the parameter is not of type TYPE_LIST

    • validateListValues

      public boolean validateListValues()
      Validate the list values defined for a parameter of type List.
      Returns:
      true if the list values are valid
      Throws:
      RuntimeException - if the parameter is not of type TYPE_LIST

    • getValue

      public String getValue()
      Gets the value.
      Overrides:
      getValue in class _ServiceParameter
      Returns:
      the value
      See Also:

    • setValue

      public void setValue(String value)
      Sets the value.
      Overrides:
      setValue in class _ServiceParameter
      Parameters:
      value - the new value
      See Also:

    • isHelpDoc

      public boolean isHelpDoc()
      Return true if a Help Doc service parameter.
      Returns:
      true if a Help Doc service parameter
      Since:
      4.3.0