Enum EAccessProperty
- All Implemented Interfaces:
IAccessProperty, INamedUiElement, Serializable, Comparable<EAccessProperty>
An access property describes the permissions a formcycle user is granted. For each new session, a boolean value
(
true [=GRANT ACCESS] or false [=DENY ACCESS]) is assigned to each property. This value may come m
either the user's current Rolle, the current license of the system; or it may be set by the system.
Some access properties (called role properties) are configurable for each Rolle, this is indicated by
isConfigurable().
Each property has also got a default, this is used when the current value could not be determined in another way. For example, when a new version is released, new access properties might have been added: for these the default is used. Note however, that
- the sadmin is unaffected by role properties, that
- the defaults of the client administrator are
true, except for system settings, and that - an access property must be assigned the value
falseif the parent access property is assigned the valuefalse.
- Author:
- XIMA MEDIA GmbH
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDeprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Available to every user that is signed inAvailable to everybodyGranted to the sadmin with a clientGranted to the sadmin without a clientDeprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated. -
Field Summary
Fields inherited from interface INamedUiElement
ATTR_DISPLAY_NAME -
Method Summary
Modifier and TypeMethodDescriptionstatic EAccessPropertyA collection of child-properties specify parts of the main property.booleanThe default value of this access property if it is not already set on the user role.The display name of this element in the given locale.getKey()The key of this access propertyintbooleanisAuthorized(ILicenseAccess licenseAccess) Checks whether this access property is authorized for the given license.booleanbooleanDeprecated.booleanbooleanstatic EAccessPropertyReturns the enum constant of this type with the specified name.static EAccessProperty[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
PUBLIC
Available to everybody -
PROTECTED
Available to every user that is signed in -
SADMIN_NO_CLIENT
Granted to the sadmin without a client -
SADMIN_CLIENT
Granted to the sadmin with a client -
PROJECTS
-
FORM_PROVIDE
-
FORM_PREVIEW
-
PROJECT_WORKFLOW
-
PROJECT_ACCESS
-
PROJECT_PUBLISH
-
PROJECT_INVITE
-
PROJECT_INVITE_SAVE
-
PROJECT_INVITE_SEND
-
PROJECT_RESSOURCE
-
PROJECT_VERSION
-
FORM_INBOX_SETTINGS
-
PROJECT_INBOX
-
PROJECT_DATA_TABLE
-
PROJECT_OPT_IN
-
PROJECT_EXPORT_PRINT
-
PROJECT_EXPORT_PORTRAIT
-
FORM_CREATE
-
FORM_DELETE
-
FORM_DELETE_FORM_RECORDS
-
FORM_COPY
-
FORM_IMPORT
-
FORM_EXPORT
-
FORM_DETAILS
-
FORM_PUBLISH
-
FORM_CREATE_TEMPLATE
-
PROJECT_GROUP
-
PROJECT_STATS
-
PROJECT_SETTINGS
-
PROJECT_LIST
-
FORM_TEMPLATE
-
USER_SETTINGS
-
USER_USER_SETTINGS
-
USER_LDAPGROUP_SETTINGS
Deprecated. -
USER_CLIENTADMIN_SETTINGS
-
USER_GROUP_SETTINGS
-
USER_EXTERNAL_SETTINGS
-
USER_EXTERNAL_USER_FACEBOOK
-
USER_EXTERNAL_USER_GOOGLE
-
USER_EXTERNAL_USER_LDAP
-
USER_EXTERNAL_USER_AZURE_AD
-
USER_EXTERNAL_USER_KERBEROS_EXTENSION
-
USER_EXTERNAL_USER_SAML
-
USER_EXTERNAL_USER_OPENID
-
USER_EXTERNAL_USER_OAUTH2
-
USER_EXTERNAL_USER_PLUGIN
-
USER_ROLE_SETTINGS
-
STATISTIC
-
INBOX_CONFIG
-
DATA
-
DATA_CONNECTION
-
DATA_LDAP_CONNECTION
-
DATA_PROMPT_CONNECTION
-
DATA_WEBDAV_CONNECTION
-
DATA_QUERY
-
DATA_LDAP_QUERY
-
DATA_PROMPT_QUERY
-
DATA_SOURCE
-
DATA_COUNTER
-
LOG
-
LOG_PROCESS
-
LOG_PROCESS_DELETE
-
LOG_HISTORY
-
LOG_HISTORY_DELETE
-
LOG_SYSTEM
-
TEMPLATE
-
TEMPLATE_CSS
-
TEMPLATE_XSL
-
TEMPLATE_HTML
-
TEMPLATE_TEXT
-
TEMPLATE_I18N_VARIABLE
-
TEMPLATE_MAIL
-
TEMPLATE_CHAT
-
TEMPLATE_URL
-
RESOURCE
-
APPOINTMENTS
-
SETTINGS
-
SETTINGS_STATISTIC
-
SETTINGS_MAIL
-
SETTINGS_LICENSE
-
SETTINGS_INFO
-
SETTINGS_DATABASE
-
SETTINGS_DRIVERS
-
SETTINGS_CLIENT
-
SETTINGS_USERS
-
SETTINGS_EXTERNAL_USER
-
SETTINGS_EXTERNAL_USER_FACEBOOK
-
SETTINGS_EXTERNAL_USER_GOOGLE
-
SETTINGS_EXTERNAL_USER_PLUGIN
-
SETTINGS_EXTERNAL_USER_LDAP
-
SETTINGS_EXTERNAL_USER_AZURE_AD
-
SETTINGS_EXTERNAL_USER_SAML
-
SETTINGS_EXTERNAL_USER_OPENID
-
SETTINGS_EXTERNAL_USER_OAUTH2
-
SETTINGS_EXTERNAL_USER_KERBEROS
-
SETTINGS_FSERVER
-
SETTINGS_CERTIFICATES
-
SETTINGS_USER_PORTAL
-
SETTINGS_USER_PORTAL_BASE
-
SETTINGS_USER_PORTAL_FORMS
-
SETTINGS_USER_PORTAL_CUSTOMIZATION
-
SETTINGS_USER_PORTAL_ADVANCED
-
SETTINGS_CLUSTER
-
SETTINGS_LOG
-
SETTINGS_PLUGIN
-
SETTINGS_GENERAL
-
SETTINGS_PROTOCOL
-
SETTINGS_LOOK_FEEL
-
SETTINGS_LOGIN_SCREEN
-
SETTINGS_MESSAGES
-
SUPPORT
-
SUPPORT_FORM
-
SUPPORT_SEND_LOGS
-
SUPPORT_SEND_FORMS
-
SUPPORT_QA
Deprecated. -
SUPPORT_HELP
Deprecated. -
FEEDBACK_FORM
Deprecated. -
SETTINGS_CLIENT_SINGLE
-
CLIENT_SINGLE_SETTINGS
-
CLIENT_SINGLE_PLUGINS
-
CLIENT_SINGLE_PLUGIN_OVERLOAD
-
CLIENT_SINGLE_CERTIFICATES
-
CLIENT_SINGLE_CONTRACT
-
CLIENT_SINGLE_FRONTSERVER
-
CLIENT_SINGLE_USER_PORTAL
-
CLIENT_USER_PORTAL_BASE
-
CLIENT_USER_PORTAL_FORMS
-
CLIENT_USER_PORTAL_CUSTOMIZATION
-
CLIENT_USER_PORTAL_ADVANCED
-
DEVELOP
-
DEVELOP_VIEW
-
SETTINGS_LDAP
Deprecated.UseUSER_EXTERNAL_USER_LDAPinstead. -
USER_INBOX
-
INBOX_CORRECTION
-
INBOX_SHOW_RECORD_IN_CURRENT_VERSION
-
INBOX_RETRIGGER
-
INBOX_STATECHANGE_NO_WORKFLOW
-
INBOX_STATECHANGE_ANY_STATE
-
INBOX_UNLOCK_FORM_RECORD
-
INBOX_RESEND_DOI_MAIL
-
INBOX_CANCEL_DOI
-
INBOX_EXPORT_VORGANG
-
INBOX_SHOW_DATATABLE
-
INBOX_SHOW_COMPLETE_DATATABLE_VALUES
-
INBOX_SHOW_FURTHER_FILTERS
-
INBOX_SHOW_FURTHER_PROCESS_DETAILS
-
INBOX_SHOW_FILTER_READ
-
INBOX_SHOW_FILTER_ATTACH
-
INBOX_SHOW_FILTER_SAVED
-
INBOX_SHOW_FILTER_STATE
-
INBOX_SHOW_FILTER_DELETABLE
-
INBOX_SHOW_FILTER_DOI
-
INBOX_SHOW_FILTER_MESSAGES
-
INBOX_SHOW_FILTER_READ_MESSAGES
-
INBOX_SHOW_FILTER_PORTAL_MESSAGES
-
INBOX_ADD_NEW_PROCESS
-
INBOX_DELETE_PROCESS
-
INBOX_MOVE_PROCESS
-
INBOX_SHOW_ORIGINAL_ATTACHMENTS
-
INBOX_SHOW_FORM_RECORD_MESSAGES
-
INBOX_ADD_FORM_RECORD_MESSAGES
-
INBOX_APPOINTMENT_VIEW
-
FORM_AUTHORIZE_PUBLISH
-
FORM_EDIT
-
DESIGNER_TOOLBAR
-
BUTTON_PUBLISH
-
BUTTON_CLONE
-
BUTTON_DELETE
-
BUTTON_OVERVIEW
-
BUTTON_UNDO
-
BUTTON_REDO
-
BUTTON_TEMPLATE_ADD
-
BUTTON_TEMPLATE_REMOVE
-
BUTTON_LOCK
-
FORM_PDF_IMPORT
-
I18NSWITCHER
-
BUTTON_PDF_IMPORT
-
BUTTON_OPTION
-
THEME_SWITCHER
-
MODERN_THEME
-
VALIDATE_SUBMIT_ACTION
-
LEGACY_USE_OPTION_TEXT_FOR_AUTOCOMPLETE
-
PAGE_RESPONSIVE
-
ERROR_SWITCHER
-
MAX_WIDTH
-
MIN_WIDTH
-
LOGO_CHECKBOX
-
BUTTON_SAVE
-
BUTTON_LOAD
-
ELEMENT_PANEL
-
ELEMENT_XPAGE
-
ELEMENT_XCONTAINER
-
ELEMENT_XCONTAINER_INVISIBLE
-
ELEMENT_XFIELD_SET
-
ELEMENT_XSPAN
-
ELEMENT_XTEXT_AREA
-
ELEMENT_XTEXT_FIELD
-
ELEMENT_XCHECKBOX
-
ELEMENT_XSELECT
-
ELEMENT_XLINE
-
ELEMENT_XIMAGE
-
ELEMENT_XSPACER
-
ELEMENT_XUPLOAD
-
ELEMENT_XBUTTON_LIST
-
SCRIPT_PANEL
-
SCRIPT_JS
-
SCRIPT_CSS
-
SCRIPT_META
-
SCRIPT_VARS
-
PROPERTY_PANEL
-
PROPERTY_MAXWIDTH
-
PROPERTY_MINWIDTH
-
PROPERTY_NAME
-
PROPERTY_FILEPREVIEW
-
PROPERTY_UPLOADMODE
-
PROPERTY_IMAGE_COMPRESSION_MODE
-
PROPERTY_IMAGE_COMPRESSION_WIDTH
-
PROPERTY_IMAGE_COMPRESSION_HEIGHT
-
PROPERTY_IMAGE_COMPRESSION_FORMAT
-
PROPERTY_IMAGE_COMPRESSION_QUALITY
-
PROPERTY_PDF_CONVERSION
-
PROPERTY_PDF_CONVERSION_KEEP_ORIGINAL
-
PROPERTY_PDF_CONVERSION_ALLOW_UNSUPPORTED
-
PROPERTY_PDF_CONVERSION_TARGET_PAGE_FORMAT
-
PROPERTY_ALIASNAME
-
PROPERTY_FLEX
-
PROPERTY_ISAPPENDABLE
-
PROPERTY_LABEL
-
PROPERTY_LABELDIR
-
PROPERTY_LABELWIDTH
-
PROPERTY_LEGEND
-
PROPERTY_PLACEHOLDER
-
PROPERTY_TITLE
-
PROPERTY_MAXFILESIZE
-
PROPERTY_FILEEXTENSION
-
PROPERTY_FILEOUTPUTALIAS
-
PROPERTY_ALT
-
PROPERTY_MAXLENGTH
-
PROPERTY_MINLENGTH
-
PROPERTY_MINVALUE
-
PROPERTY_MAXVALUE
-
PROPERTY_VRULE
-
PROPERTY_VRULEMISMATCH
-
PROPERTY_VALUE
-
PROPERTY_TEXTALIGN
-
PROPERTY_HEIGHT
-
PROPERTY_RTEVALUE
-
PROPERTY_IMAGE
-
PROPERTY_BUTTONS
-
PROPERTY_ATTRIBUTES
-
PROPERTY_OPTIONS
-
PROPERTY_COMPUTEDWIDTH
-
PROPERTY_PARENTID
-
PROPERTY_ROWID
-
PROPERTY_REQUIRED
-
PROPERTY_REQUIREDIF
-
PROPERTY_REQUIREDIFCOMP
-
PROPERTY_REQUIREDIFVALUE
-
PROPERTY_READONLYIF
-
PROPERTY_READONLYIFCLEAR
-
PROPERTY_READONLYIFCOMP
-
PROPERTY_READONLYIFVALUE
-
PROPERTY_HIDDENIF
-
PROPERTY_HIDDENIFCLEAR
-
PROPERTY_HIDDENIFVALUE
-
PROPERTY_HIDDENIFCOMP
-
PROPERTY_ISHIDDEN
-
PROPERTY_SERVERVALIDATE
-
PROPERTY_UNITWIDTH
-
PROPERTY_UNIT
-
PROPERTY_ISREADONLY
-
PROPERTY_DYNAMIC
-
PROPERTY_REQUIREDGROUP
-
PROPERTY_CHECKEDVALUE
-
PROPERTY_ID
-
PROPERTY_EQUALS
-
PROPERTY_DATASOURCE
-
PROPERTY_CSSCLASSES
-
PROPERTY_CSSCLASSESWRAPPER
-
PROPERTY_SELECTLAYOUT
-
PROPERTY_SELECTTEXTLAYOUT
-
PROPERTY_SELECTCOLUMNWIDTH
-
PROPERTY_CHECKBOXMIN
-
PROPERTY_CHECKBOXMAX
-
PROPERTY_MASK
-
PROPERTY_HELPTEXT
-
PROPERTY_I18N
-
PROPERTY_STATUSDEPENDENT
-
PROPERTY_VIEWSTATUS
-
PROPERTY_USERGROUPPENDENT
-
PROPERTY_VIEWUSERGROUP
-
PROPERTY_READONLY_STATUSDEPENDENT
-
PROPERTY_READONLY_VIEWSTATUS
-
PROPERTY_READONLY_USERGROUPPENDANT
-
PROPERTY_READONLY_VIEWUSERGROUP
-
PROPERTY_COMMENT
-
PROPERTY_DATATYPE
-
SETTINGS_KERBEROS
Deprecated.useSETTINGS_EXTERNAL_USER_KERBEROSinstead. -
SETTINGS_NTLM
Deprecated. -
DASHBOARD
Deprecated. -
PROJECT_DASH
Deprecated. -
FORM_UPDATE
Deprecated. -
MANDANT_FRONTEND_SERVER_CONFIG
Deprecated. -
LOG_STATUS
Deprecated. -
SETTINGS_UPDATE
Deprecated. -
BUTTON_HELP
Deprecated. -
ADOBE_IMPORTER
Deprecated. -
SETTINGS_CLIENT_AUTHORIZE_PUBLISH
Deprecated. -
PROPERTY_NOTE
Deprecated.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
getKey
Description copied from interface:IAccessPropertyThe key of this access property- Specified by:
getKeyin interfaceIAccessProperty- Returns:
Stringthe key
-
getDefaultValue
public boolean getDefaultValue()Description copied from interface:IAccessPropertyThe default value of this access property if it is not already set on the user role. Also this value will be used to define the initial status in the user role UI.- Specified by:
getDefaultValuein interfaceIAccessProperty- Returns:
- The default value of this access property, in case no value could be determined otherwise. This is used
eg. during a system update to set the defaults for
Rolleproperties for new properties that were not present in the previous version.
-
getChildren
Description copied from interface:IAccessPropertyA collection of child-properties specify parts of the main property. Also the children will be displayed in a second column in the UI.- Specified by:
getChildrenin interfaceIAccessProperty- Returns:
- A list of all child properties, ie. those that have this property set as their parent.
-
getByKey
-
getParent
- Returns:
- The parent of this access property. When a user is not granted the parent access property, they are not
granted any child properties either. May be
null, in which case this is a top-level property.
-
getDisplayName
Description copied from interface:INamedUiElementThe display name of this element in the given locale.- Specified by:
getDisplayNamein interfaceINamedUiElement- Parameters:
l- The locale to get the display name for.- Returns:
- The display name of this element in the given locale.
-
isConfigurable
public boolean isConfigurable()- Returns:
- Whether this access property is configurable separately for each
Rolle. Iffalse, the property is set by the license or the system etc.
-
isSysPermission
public boolean isSysPermission()- Returns:
- Whether this access property is a system permission. If
true, the property is set a system permission and not intended for client roles.
-
getNestingDepth
public int getNestingDepth()- Returns:
- The nesting depth of this access, ie. the number of
getParent().
-
getChildrenRecursive
- Returns:
- A list of all children, grand-children, grand-grand-children etc. of this access property.
-
isAuthorized
Checks whether this access property is authorized for the given license. If this property has parent properties, all of them must be authorized with the given license for this property to be authorized.- Parameters:
licenseAccess- The license access to check against.- Returns:
trueif the access property is authorized,falseotherwise.
-
isLicenseFeature
- Throws:
NoSuchFieldException
-
isLicenseDefaultAccess
Deprecated.
-
USER_EXTERNAL_USER_LDAPinstead.