Package com.avoka.fc.core.entity

Class PortalProperty

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._PortalProperty

com.avoka.fc.core.entity.PortalProperty

All Implemented Interfaces:

IEntity, Auditable, Serializable, org.apache.cayenne.DataObject, org.apache.cayenne.Persistent, org.apache.cayenne.Validating

@CacheGroups("CONFIG")
public class PortalProperty
extends _PortalProperty
implements Auditable

Provides a typed property for a portal.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADMIN_ENVIRONMENT_CSS_STYLE	The Administration Server environment CSS style.
static String	ADMIN_ENVIRONMENT_NAME	The Administration Server environment name, e.g.
static String	ALLOW_XML_REDIRECT_TARGET	The "Allow XML Redirect Target" property.
static String	ALLOW_XML_REQUEST_PARAM_FORM_PREFILL	The "Allow XML Parameter Form Prefill" property.
static String	BROWSER_AUTO_LOGOUT	The Administration Server browser auto logout property.
static String	CACHE_HEADERS	The Cache Headers property.
static String	CSRF_PROTECTION	The property value "CSRF Protection".
static String	CSRF_PROTECTION_HOST_CHECK	The property value "CSRF Protection Host Check".
static String	DATETIME_FORMAT_DEFAULT	The default date time format.
static String	DOCUMENTATION_URL	External documentation URL for JM reference material.
static String	ENHANCED_PII_SEARCH	The property value "Enhanced PII Search" functionality.
static String	ENHANCED_PII_SEARCH_LIMIT	The property value "Enhanced PII Search Limit" functionality.
static String	PROPERTY_ACCOUNT_LOCKED_MESSAGE	The "Account Locked Message" property
static String	PROPERTY_ACCOUNT_QUICK_LISTS_ENABLED	The "Account Quick Lists Enabled" property
static String	PROPERTY_ALLOW_FORM_CANCEL	The "Allow Form Cancel" property
static String	PROPERTY_ALLOW_FORM_RETRY	The "Allow Form Retry" property
static String	PROPERTY_ANONYMOUS_SUBMISSION_ACCESS_TIMEOUT	The "Anonymous Submission Access Timeout" property
static String	PROPERTY_AUTHENTICATED_WEB_SERVICES	The list of authenticated SFM Web Services.
static String	PROPERTY_AUTO_SAVE_INTERVAL	The "Auto Save Interval" property for Field Worker app.
static String	PROPERTY_AUTO_SUBMISSION_INTERVAL	The "Auto Submission Interval" property for Field Worker app.
static String	PROPERTY_CDN_SERVER_URL	The "CDN Server URL" property
static String	PROPERTY_CLIENT_SESSION_TIMEOUT	The "Client Session Timeout" property for Field Worker app.
static String	PROPERTY_DATETIME_FORMAT	The "Datetime Format" property
static String	PROPERTY_DIGITAL_SIGNATURE_INVALID_TEXT	The "Digital Signature Invalid Text" property
static String	PROPERTY_ENABLE_PREVIOUS_PDF_SUBMISSIONS	The "Enable Previous PDF Submissions" property
static String	PROPERTY_GOOGLE_API_KEY	The "Google API Key" property
static String	PROPERTY_MAX_CLIENT_HISTORY_SUBMISSIONS	The "Max Client History Submissions" property for Field Worker app.
static String	PROPERTY_MAX_CLIENT_USER_TASKS	The "Max Client User Tasks" property for Field Worker app.
static String	PROPERTY_REQUIRE_CLIENT_KEY	The "Require Client Key" property for form render.
static String	PROPERTY_SEARCH_CONSISTENT_READ	The "Search Consistent Read" property for Work Spaces.
static String	PROPERTY_SEARCH_DATA_EXTRACTS	The "Search Data Extracts" property for Work Spaces.
static String	PROPERTY_SEARCH_DATA_LOAD	The "Search Mode" property
static String	PROPERTY_SEARCH_FETCH_LIMIT	The "Search Fetch Limit" property for Work Spaces.
static String	PROPERTY_SEARCH_FILTER_GROUP_SELECT	The "Search Filter Group Select" property for Work Spaces.
static String	PROPERTY_SEARCH_FILTER_JOBS_BY_USER_ORGS	The "Search Filter Jobs By User Orgs" property for Work Spaces.
static String	PROPERTY_SEARCH_PERIOD_HELP_DESK	The "Search Period Tasks" property for Work Spaces.
static String	PROPERTY_SEARCH_PERIOD_HISTORY	The "Search Period History" property for Work Spaces.
static String	PROPERTY_SEARCH_PERIOD_REVIEWS	The "Search Period Reviews" property for Work Spaces.
static String	PROPERTY_SEARCH_PERIOD_TASKS	The "Search Period Tasks" property for Work Spaces.
static String	PROPERTY_SEARCH_TASK_ATTRIBUTES	The "Search Task Attributes" property for Work Spaces.
static String	PROPERTY_SERVER_BUSY_REDIRECT_URL	The "Server Busy Redirect URL" property to redirect requests to if the server is too busy.
static String	PROPERTY_SYNC_LOGGING_LEVEL	The T.Field "Sync Logging Level" property.
static String	PROPERTY_UI_MAPPING	The "UI Mapping" property
static String	PROPERTY_VALUE_GROOVY_AND_TASK	The property value "Groovy and Task".
static String	SEARCH_DATA_LOAD_EAGER	The "Eager" data load mode.
static String	SEARCH_DATA_LOAD_LAZY	The "Lazy" data load mode.
static String	SEARCH_PII_FETCH_LIMIT	The property value "Search PII Fetch Limit".
static String	SECURITY_HEADERS	The Security Headers property.
static String	SHOW_DEPRECATED_FEATURES	Boolean to show deprecated features.
static String	SYNC_LOGGING_LEVEL_DETAIL	The property value "Detail".
static String	TYPE_BOOLEAN	Indicates that the property can be assigned only the values "true" and "false"
static String	TYPE_CSV	Indicates that the property will contain comma-separated values
static String	TYPE_DATE	Indicates that the property can be assigned a date/time value
static String	TYPE_HTML	Indicates that the property can be assigned any string value
static String	TYPE_JSON	Indicates that the property will contain a JSON string
static String	TYPE_LIST	Indicates that the property can be assigned one of a list of values
static String	TYPE_NUMBER	Indicates that the property can be assigned a numeric value
static String	TYPE_STRING	Indicates that the property can be assigned any string value
static String[]	TYPES	The full set of portal property types
static String	USE_EMAIL_FOR_LOGIN	The "Use Email for Login" property.
static String	USER_ACCOUNT_CREATION_URL	The "User Account Creation URL" property.
static String	X_FRAME_OPTIONS	The "X-Frame-Options" property.

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

DESCRIPTION, DESCRIPTION_PROPERTY, LIST_VALUES, LIST_VALUES_PROPERTY, NAME, NAME_PROPERTY, PORTAL, PORTAL_PROPERTY, PORTAL_PROPERTY_OID_PK_COLUMN, REQUIRED_FLAG, REQUIRED_FLAG_PROPERTY, TYPE, TYPE_PROPERTY, VALUE, VALUE_PROPERTY

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

ID_PROPERTY

Fields inherited from class org.apache.cayenne.CayenneDataObject

values

Fields inherited from class org.apache.cayenne.BaseDataObject

snapshotVersion

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
PortalProperty()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getListValuesMap()	Return the list of values.
boolean	isTypeCSV()
boolean	isTypeJSON()

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

getDescription, getListValues, getName, getPortal, getType, getValue, isRequiredFlag, setDescription, setListValues, setName, setPortal, setRequiredFlag, setType, setValue

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

appendProperties, getId, getValuesMap, isNew, setId, toString

Methods inherited from class org.apache.cayenne.CayenneDataObject

makePath, readPropertyDirectly, readState, setPersistenceState, writePropertyDirectly, writeState

Methods inherited from class org.apache.cayenne.BaseDataObject

addToManyTarget, beforePropertyRead, beforePropertyWrite, getSnapshotVersion, readNestedProperty, readProperty, readSerialized, removeToManyTarget, setObjectContext, setReverseRelationship, setSnapshotVersion, setToManyTarget, setToOneTarget, toStringBuffer, unsetReverseRelationship, validateForDelete, validateForInsert, validateForSave, validateForUpdate, willConnect, writeProperty, writeSerialized

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

TYPE_BOOLEAN

public static final String TYPE_BOOLEAN

Indicates that the property can be assigned only the values "true" and "false"

See Also:

Constant Field Values

TYPE_CSV

public static final String TYPE_CSV

Indicates that the property will contain comma-separated values

See Also:

Constant Field Values

TYPE_DATE

public static final String TYPE_DATE

Indicates that the property can be assigned a date/time value

See Also:

Constant Field Values

TYPE_HTML

public static final String TYPE_HTML

Indicates that the property can be assigned any string value

See Also:

Constant Field Values

TYPE_JSON

public static final String TYPE_JSON

Indicates that the property will contain a JSON string

See Also:

Constant Field Values

TYPE_LIST

public static final String TYPE_LIST

Indicates that the property can be assigned one of a list of values

See Also:

Constant Field Values

TYPE_NUMBER

public static final String TYPE_NUMBER

Indicates that the property can be assigned a numeric value

See Also:

Constant Field Values

TYPE_STRING

public static final String TYPE_STRING

Indicates that the property can be assigned any string value

See Also:

Constant Field Values

TYPES

public static final String[] TYPES

The full set of portal property types

PROPERTY_AUTHENTICATED_WEB_SERVICES

public static final String PROPERTY_AUTHENTICATED_WEB_SERVICES

The list of authenticated SFM Web Services.

See Also:

Constant Field Values

PROPERTY_ACCOUNT_LOCKED_MESSAGE

public static final String PROPERTY_ACCOUNT_LOCKED_MESSAGE

The "Account Locked Message" property

See Also:

Constant Field Values

PROPERTY_ACCOUNT_QUICK_LISTS_ENABLED

public static final String PROPERTY_ACCOUNT_QUICK_LISTS_ENABLED

The "Account Quick Lists Enabled" property

See Also:

Constant Field Values

PROPERTY_ALLOW_FORM_CANCEL

public static final String PROPERTY_ALLOW_FORM_CANCEL

The "Allow Form Cancel" property

See Also:

Constant Field Values

PROPERTY_ALLOW_FORM_RETRY

public static final String PROPERTY_ALLOW_FORM_RETRY

The "Allow Form Retry" property

See Also:

Constant Field Values

PROPERTY_ANONYMOUS_SUBMISSION_ACCESS_TIMEOUT

public static final String PROPERTY_ANONYMOUS_SUBMISSION_ACCESS_TIMEOUT

The "Anonymous Submission Access Timeout" property

See Also:

Constant Field Values

PROPERTY_CDN_SERVER_URL

public static final String PROPERTY_CDN_SERVER_URL

The "CDN Server URL" property

See Also:

Constant Field Values

PROPERTY_DATETIME_FORMAT

public static final String PROPERTY_DATETIME_FORMAT

The "Datetime Format" property

See Also:

Constant Field Values

PROPERTY_DIGITAL_SIGNATURE_INVALID_TEXT

public static final String PROPERTY_DIGITAL_SIGNATURE_INVALID_TEXT

The "Digital Signature Invalid Text" property

See Also:

Constant Field Values

PROPERTY_ENABLE_PREVIOUS_PDF_SUBMISSIONS

public static final String PROPERTY_ENABLE_PREVIOUS_PDF_SUBMISSIONS

The "Enable Previous PDF Submissions" property

See Also:

Constant Field Values

PROPERTY_GOOGLE_API_KEY

public static final String PROPERTY_GOOGLE_API_KEY

The "Google API Key" property

See Also:

Constant Field Values

PROPERTY_SEARCH_DATA_LOAD

public static final String PROPERTY_SEARCH_DATA_LOAD

The "Search Mode" property

See Also:

Constant Field Values

PROPERTY_UI_MAPPING

public static final String PROPERTY_UI_MAPPING

The "UI Mapping" property

See Also:

Constant Field Values

ADMIN_ENVIRONMENT_NAME

public static final String ADMIN_ENVIRONMENT_NAME

The Administration Server environment name, e.g. Production.

See Also:

Constant Field Values

ADMIN_ENVIRONMENT_CSS_STYLE

public static final String ADMIN_ENVIRONMENT_CSS_STYLE

The Administration Server environment CSS style.

See Also:

Constant Field Values

BROWSER_AUTO_LOGOUT

public static final String BROWSER_AUTO_LOGOUT

The Administration Server browser auto logout property.

See Also:

Constant Field Values

PROPERTY_MAX_CLIENT_USER_TASKS

public static final String PROPERTY_MAX_CLIENT_USER_TASKS

The "Max Client User Tasks" property for Field Worker app.

See Also:

Constant Field Values

PROPERTY_MAX_CLIENT_HISTORY_SUBMISSIONS

public static final String PROPERTY_MAX_CLIENT_HISTORY_SUBMISSIONS

The "Max Client History Submissions" property for Field Worker app.

See Also:

Constant Field Values

PROPERTY_AUTO_SAVE_INTERVAL

public static final String PROPERTY_AUTO_SAVE_INTERVAL

The "Auto Save Interval" property for Field Worker app.

See Also:

Constant Field Values

PROPERTY_AUTO_SUBMISSION_INTERVAL

public static final String PROPERTY_AUTO_SUBMISSION_INTERVAL

The "Auto Submission Interval" property for Field Worker app.

See Also:

Constant Field Values

PROPERTY_CLIENT_SESSION_TIMEOUT

public static final String PROPERTY_CLIENT_SESSION_TIMEOUT

The "Client Session Timeout" property for Field Worker app.

See Also:

Constant Field Values

PROPERTY_REQUIRE_CLIENT_KEY

public static final String PROPERTY_REQUIRE_CLIENT_KEY

The "Require Client Key" property for form render.

See Also:

Constant Field Values

PROPERTY_SEARCH_CONSISTENT_READ

public static final String PROPERTY_SEARCH_CONSISTENT_READ

The "Search Consistent Read" property for Work Spaces.

See Also:

Constant Field Values

PROPERTY_SEARCH_DATA_EXTRACTS

public static final String PROPERTY_SEARCH_DATA_EXTRACTS

The "Search Data Extracts" property for Work Spaces.

See Also:

Constant Field Values

PROPERTY_SEARCH_PERIOD_TASKS

public static final String PROPERTY_SEARCH_PERIOD_TASKS

The "Search Period Tasks" property for Work Spaces.

See Also:

Constant Field Values

PROPERTY_SEARCH_PERIOD_HISTORY

public static final String PROPERTY_SEARCH_PERIOD_HISTORY

The "Search Period History" property for Work Spaces.

See Also:

Constant Field Values

PROPERTY_SEARCH_PERIOD_REVIEWS

public static final String PROPERTY_SEARCH_PERIOD_REVIEWS

The "Search Period Reviews" property for Work Spaces.

See Also:

Constant Field Values

PROPERTY_SEARCH_PERIOD_HELP_DESK

public static final String PROPERTY_SEARCH_PERIOD_HELP_DESK

The "Search Period Tasks" property for Work Spaces.

See Also:

Constant Field Values

PROPERTY_SEARCH_FETCH_LIMIT

public static final String PROPERTY_SEARCH_FETCH_LIMIT

The "Search Fetch Limit" property for Work Spaces.

See Also:

Constant Field Values

PROPERTY_SEARCH_FILTER_GROUP_SELECT

public static final String PROPERTY_SEARCH_FILTER_GROUP_SELECT

The "Search Filter Group Select" property for Work Spaces.

See Also:

Constant Field Values

PROPERTY_SEARCH_FILTER_JOBS_BY_USER_ORGS

public static final String PROPERTY_SEARCH_FILTER_JOBS_BY_USER_ORGS

The "Search Filter Jobs By User Orgs" property for Work Spaces.

See Also:

Constant Field Values

PROPERTY_SEARCH_TASK_ATTRIBUTES

public static final String PROPERTY_SEARCH_TASK_ATTRIBUTES

The "Search Task Attributes" property for Work Spaces.

See Also:

Constant Field Values

PROPERTY_SERVER_BUSY_REDIRECT_URL

public static final String PROPERTY_SERVER_BUSY_REDIRECT_URL

The "Server Busy Redirect URL" property to redirect requests to if the server is too busy.

See Also:

Constant Field Values

PROPERTY_SYNC_LOGGING_LEVEL

public static final String PROPERTY_SYNC_LOGGING_LEVEL

The T.Field "Sync Logging Level" property.

See Also:

Constant Field Values

USER_ACCOUNT_CREATION_URL

public static final String USER_ACCOUNT_CREATION_URL

The "User Account Creation URL" property.

See Also:

Constant Field Values

USE_EMAIL_FOR_LOGIN

public static final String USE_EMAIL_FOR_LOGIN

The "Use Email for Login" property.

See Also:

Constant Field Values

X_FRAME_OPTIONS

public static final String X_FRAME_OPTIONS

The "X-Frame-Options" property.

See Also:

Constant Field Values

ALLOW_XML_REQUEST_PARAM_FORM_PREFILL

public static final String ALLOW_XML_REQUEST_PARAM_FORM_PREFILL

The "Allow XML Parameter Form Prefill" property.

See Also:

Constant Field Values

ALLOW_XML_REDIRECT_TARGET

public static final String ALLOW_XML_REDIRECT_TARGET

The "Allow XML Redirect Target" property.

See Also:

Constant Field Values

PROPERTY_VALUE_GROOVY_AND_TASK

public static final String PROPERTY_VALUE_GROOVY_AND_TASK

The property value "Groovy and Task".

See Also:

Constant Field Values

CACHE_HEADERS

public static final String CACHE_HEADERS

The Cache Headers property.

See Also:

Constant Field Values

CSRF_PROTECTION

public static final String CSRF_PROTECTION

The property value "CSRF Protection".

See Also:

Constant Field Values

CSRF_PROTECTION_HOST_CHECK

public static final String CSRF_PROTECTION_HOST_CHECK

The property value "CSRF Protection Host Check".

See Also:

Constant Field Values

ENHANCED_PII_SEARCH

public static final String ENHANCED_PII_SEARCH

The property value "Enhanced PII Search" functionality.

See Also:

Constant Field Values

ENHANCED_PII_SEARCH_LIMIT

public static final String ENHANCED_PII_SEARCH_LIMIT

The property value "Enhanced PII Search Limit" functionality.

See Also:

Constant Field Values

SEARCH_PII_FETCH_LIMIT

public static final String SEARCH_PII_FETCH_LIMIT

The property value "Search PII Fetch Limit".

See Also:

Constant Field Values

DATETIME_FORMAT_DEFAULT

public static final String DATETIME_FORMAT_DEFAULT

The default date time format.

See Also:

Constant Field Values

SEARCH_DATA_LOAD_EAGER

public static final String SEARCH_DATA_LOAD_EAGER

The "Eager" data load mode.

See Also:

Constant Field Values

SEARCH_DATA_LOAD_LAZY

public static final String SEARCH_DATA_LOAD_LAZY

The "Lazy" data load mode.

See Also:

Constant Field Values

SYNC_LOGGING_LEVEL_DETAIL

public static final String SYNC_LOGGING_LEVEL_DETAIL

The property value "Detail".

See Also:

Constant Field Values

SHOW_DEPRECATED_FEATURES

public static final String SHOW_DEPRECATED_FEATURES

Boolean to show deprecated features.

See Also:

Constant Field Values

SECURITY_HEADERS

public static final String SECURITY_HEADERS

The Security Headers property.

See Also:

Constant Field Values

DOCUMENTATION_URL

public static final String DOCUMENTATION_URL

External documentation URL for JM reference material.

See Also:

Constant Field Values

Constructor Detail

PortalProperty

public PortalProperty()

Method Detail

isTypeCSV

public boolean isTypeCSV()

Returns:

true if the property type is 'CSV'

Since:

5.1.4

isTypeJSON

public boolean isTypeJSON()

Returns:

true if the property type is 'JSON'

Since:

5.1.4

getListValuesMap

public Map<String,String> getListValuesMap()

Return the list of values. Each list value consists of a pair of strings: The actual value and a display string.

Returns:

a map of the list values

Throws:

RuntimeException - if the current property is not of type TYPE_LIST