Package com.avoka.fc.core.entity

Class ServiceParameter

java.lang.Object

org.apache.cayenne.PersistentObject

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:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	DATE_FORMAT_PATTERN	The format pattern used when storing service parameters of type date
static String	FORM_PROPERTY_EDITOR_DEFINITION_PARAMETER	The 'Form Property Editor Definition' parameter name.
static String	GROOVY_SCRIPT_PARAMETER	The 'groovyScript' parameter name.
static String	HELP_DOC_PARAMETER	The 'Help Doc' parameter name.
static String	JOB_DEFINITION_PARAMETER	The 'jobDefinition' parameter name.
static String	REST_INVOKE_ENABLED	The 'REST Invoke Enabled' parameter name.
static String	TEST_EMAIL_ADDRESSES	The 'Email Addresses' parameter name.
static String	TEST_EMAIL_NOTIFICATIONS	The 'Email Notifications' parameter name.
static String	TEST_SUITE_SERVICES	The 'Test Suite Services' parameter name.
static String	TYPE_BOOLEAN	Indicates that the parameter can accept the values "true" and "false"
static String	TYPE_DATE	Indicates that the parameter can accept date values
static String	TYPE_EMAIL	Indicates that the parameter can accept a valid email address
static String	TYPE_GROOVY_SCRIPT	Indicates that the parameter can accept Groovy script
static String	TYPE_HTML	Indicates that the parameter can accept HTML values
static String	TYPE_JSON	Indicates that the parameter can accept JSON values
static String	TYPE_LIST	Indicates that the parameter can accept a value from a pre-defined list
static String	TYPE_NUMBER	Indicates that the parameter can accept numeric values
static String	TYPE_PASSWORD	Indicates that the parameter can accept password values
static String	TYPE_STRING	Indicates that the parameter can accept string values
static String[]	TYPES	The full set of possible data types
static String	UNIT_TEST_SCRIPT_PARAMETER	The 'Unit Test Script' parameter name.

Fields inherited from class com.avoka.fc.core.entity.auto._ServiceParameter

BIND_PARAMETER_FLAG, BIND_PARAMETER_FLAG_PROPERTY, CLEAR_ON_EXPORT_FLAG, CLEAR_ON_EXPORT_FLAG_PROPERTY, CREATED_AT, CREATED_AT_PROPERTY, CREATED_BY, CREATED_BY_PROPERTY, DESCRIPTION, DESCRIPTION_PROPERTY, LAST_MODIFIED_AT, LAST_MODIFIED_AT_PROPERTY, LAST_MODIFIED_BY, LAST_MODIFIED_BY_PROPERTY, LIST_VALUES, LIST_VALUES_PROPERTY, NAME, NAME_PROPERTY, READONLY_FLAG, READONLY_FLAG_PROPERTY, REQUIRED_FLAG, REQUIRED_FLAG_PROPERTY, SERVICE, SERVICE_PARAMETER_HISTORY, SERVICE_PARAMETER_HISTORY_PROPERTY, SERVICE_PARAMETER_OID_PK_COLUMN, SERVICE_PROPERTY, TYPE, TYPE_PROPERTY, UNIT_TEST_FLAG, UNIT_TEST_FLAG_PROPERTY, VALUE, VALUE_PROPERTY

Fields inherited from class com.avoka.core.entity.BaseEntity

ID_PROPERTY

Fields inherited from class org.apache.cayenne.CayenneDataObject

snapshotVersion, values

Fields inherited from class org.apache.cayenne.PersistentObject

objectContext, objectId, persistenceState

Fields inherited from interface org.apache.cayenne.DataObject

DEFAULT_VERSION

Constructor Summary

Constructors

Constructor	Description
ServiceParameter()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getListValuesMap()	Return the values for a list parameter.
String	getValue()	Gets the value.
boolean	isHelpDoc()	Return true if a Help Doc service parameter.
void	setValue(String value)	Sets the value.
boolean	validateListValues()	Validate the list values defined for a parameter of type List.

Methods inherited from class com.avoka.fc.core.entity.auto._ServiceParameter

addToServiceParameterHistory, getCreatedAt, getCreatedBy, getDescription, getLastModifiedAt, getLastModifiedBy, getListValues, getName, getService, getServiceParameterHistory, getType, isBindParameterFlag, isClearOnExportFlag, isReadonlyFlag, isRequiredFlag, isUnitTestFlag, removeFromServiceParameterHistory, setBindParameterFlag, setClearOnExportFlag, setCreatedAt, setCreatedBy, setDescription, setLastModifiedAt, setLastModifiedBy, setListValues, setName, setReadonlyFlag, setRequiredFlag, setService, setType, setUnitTestFlag

Methods inherited from class com.avoka.core.entity.BaseEntity

appendProperties, getId, getValuesMap, isNew, setId, toString

Methods inherited from class org.apache.cayenne.CayenneDataObject

addToManyTarget, getSnapshotVersion, makePath, readNestedProperty, readProperty, readPropertyDirectly, removeToManyTarget, setObjectContext, setPersistenceState, setReverseRelationship, setSnapshotVersion, setToManyTarget, setToOneTarget, toStringBuffer, unsetReverseRelationship, validateForDelete, validateForInsert, validateForSave, validateForUpdate, willConnect, writeProperty, writePropertyDirectly

Methods inherited from class org.apache.cayenne.PersistentObject

getMapKey, getObjectContext, getObjectId, getPersistenceState, setObjectId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.avoka.fc.core.entity.Auditable

getId, getValuesMap

Methods inherited from interface org.apache.cayenne.Persistent

getObjectContext, getObjectId, getPersistenceState, setObjectContext, setObjectId, setPersistenceState

Field Detail

GROOVY_SCRIPT_PARAMETER

public static final String GROOVY_SCRIPT_PARAMETER

The 'groovyScript' parameter name.

See Also:

Constant Field Values

UNIT_TEST_SCRIPT_PARAMETER

public static final String UNIT_TEST_SCRIPT_PARAMETER

The 'Unit Test Script' parameter name.

See Also:

Constant Field Values

TEST_SUITE_SERVICES

public static final String TEST_SUITE_SERVICES

The 'Test Suite Services' parameter name.

See Also:

Constant Field Values

REST_INVOKE_ENABLED

public static final String REST_INVOKE_ENABLED

The 'REST Invoke Enabled' parameter name.

See Also:

Constant Field Values

TEST_EMAIL_NOTIFICATIONS

public static final String TEST_EMAIL_NOTIFICATIONS

The 'Email Notifications' parameter name.

See Also:

Constant Field Values

TEST_EMAIL_ADDRESSES

public static final String TEST_EMAIL_ADDRESSES

The 'Email Addresses' parameter name.

See Also:

Constant Field Values

HELP_DOC_PARAMETER

public static final String HELP_DOC_PARAMETER

The 'Help Doc' parameter name.

See Also:

Constant Field Values

JOB_DEFINITION_PARAMETER

public static final String JOB_DEFINITION_PARAMETER

The 'jobDefinition' parameter name.

See Also:

Constant Field Values

FORM_PROPERTY_EDITOR_DEFINITION_PARAMETER

public static final String FORM_PROPERTY_EDITOR_DEFINITION_PARAMETER

The 'Form Property Editor Definition' parameter name.

See Also:

Constant Field Values

TYPE_BOOLEAN

public static final String TYPE_BOOLEAN

Indicates that the parameter can accept the values "true" and "false"

See Also:

Constant Field Values

TYPE_DATE

public static final String TYPE_DATE

Indicates that the parameter can accept date values

See Also:

Constant Field Values

TYPE_EMAIL

public static final String TYPE_EMAIL

Indicates that the parameter can accept a valid email address

See Also:

Constant Field Values

TYPE_GROOVY_SCRIPT

public static final String TYPE_GROOVY_SCRIPT

Indicates that the parameter can accept Groovy script

See Also:

Constant Field Values

TYPE_HTML

public static final String TYPE_HTML

Indicates that the parameter can accept HTML values

See Also:

Constant Field Values

TYPE_JSON

public static final String TYPE_JSON

Indicates that the parameter can accept JSON values

See Also:

Constant Field Values

TYPE_LIST

public static final String TYPE_LIST

Indicates that the parameter can accept a value from a pre-defined list

See Also:

Constant Field Values

TYPE_NUMBER

public static final String TYPE_NUMBER

Indicates that the parameter can accept numeric values

See Also:

Constant Field Values

TYPE_STRING

public static final String TYPE_STRING

Indicates that the parameter can accept string values

See Also:

Constant Field Values

TYPE_PASSWORD

public static final String TYPE_PASSWORD

Indicates that the parameter can accept password values

See Also:

Constant Field Values

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:

Constant Field Values

Constructor Detail

ServiceParameter

public ServiceParameter()

Method Detail

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:

_ServiceParameter.getValue()

setValue

public void setValue(String value)

Sets the value.

Overrides:

setValue in class _ServiceParameter

Parameters:

value - the new value

See Also:

_ServiceParameter.setValue(java.lang.String)

isHelpDoc

public boolean isHelpDoc()

Return true if a Help Doc service parameter.

Returns:

true if a Help Doc service parameter

Since:

4.3.0