validation

Parent: page

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringYesdata type=string; maxLen=255
Enter the name for the validation. This name should be descriptive so that developers can easily identify conditions being checked.

Property Groups:

  • execution
  • validation
  • advanced
  • error
  • serverSideCondition
  • security
  • config
  • comments
execution
PropertyTypeRequiredDefault ValueDetails
sequencenumberYesdata type=number; maxLen=22
execution {
  sequence: 42
}
validation
PropertyTypeRequiredDefault ValueDetails
editableRegionreferenceNodata type=reference; lov=COMPONENT; references=region
typeenumYesexpressiondata type=string; lov=STATIC
Valid values: rowsReturned noRowsReturned expression plsqlError functionBodyReturningBoolean functionBody itemIsNotNull itemIsNotNullOrZero itemIsNotZero itemContainsNoSpaces itemIsAlphanumeric itemIsNumeric itemIsAValidDate itemIsAValidTimestamp item=Value item!=Value itemIsContainedInValue itemIsNotContainedInValue itemContainsOnlyCharsInValue itemContainsAtLeastOneOfCharsInValue itemContainsNoneOfCharsInValue itemMatchesRegexp
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype in (rowsReturned)type in (noRowsReturned)
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies whentype = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype = functionBodyReturningBoolean
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = functionBodyReturningBoolean and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = functionBodyReturningBoolean and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = functionBody and language = javaScript-mle
plsqlCodeRaisingErrormultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = plsqlError
itemstringYesdata type=string; maxLen=255; textCase=UPPER
regexpstringYesdata type=string; maxLen=4000
Applies whentype = itemMatchesRegexp
valuemultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype in (item=Value)type in (item!=Value)type in (itemIsContainedInValue)type in (itemIsNotContainedInValue)type in (itemContainsAtLeastOneOfCharsInValue)type in (itemContainsOnlyCharsInValue)type in (itemContainsNoneOfCharsInValue)
typeenumYesexpressiondata type=string; lov=STATIC
Valid values: rowsReturned noRowsReturned expression plsqlError functionBodyReturningBoolean functionBody columnIsNotNull columnIsNotNullOrZero columnIsNotZero columnContainsNoSpaces columnIsAlphanumeric columnIsNumeric columnIsAValidDate columnIsAValidTimestamp column=Value column!=Value columnIsContainedInValue columnIsNotContainedInValue columnContainsOnlyCharsInValue columnContainsAtLeastOneOfCharsInValue columnContainsNoneOfCharsInValue columnMatchesRegexp
Applies wheneditableRegion is set
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies wheneditableRegion is set and type in (rowsReturned)editableRegion is set and type in (noRowsReturned)
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies wheneditableRegion is set and type = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies wheneditableRegion is set and type = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies wheneditableRegion is set and type = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies wheneditableRegion is set and type = expression and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies wheneditableRegion is set and type = functionBodyReturningBoolean
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies wheneditableRegion is set and type = functionBodyReturningBoolean and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies wheneditableRegion is set and type = functionBodyReturningBoolean and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies wheneditableRegion is set and type = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies wheneditableRegion is set and type = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies wheneditableRegion is set and type = functionBody and language = javaScript-mle
plsqlCodeRaisingErrormultiline stringYesdata type=multiline string; maxLen=4000
Applies wheneditableRegion is set and type = plsqlError
columnstringYesdata type=string; maxLen=128
Applies wheneditableRegion is set
regexpstringYesdata type=string; maxLen=4000
Applies wheneditableRegion is set and type = columnMatchesRegexp
valuemultiline stringYesdata type=multiline string; maxLen=4000
Applies wheneditableRegion is set and type in (column=Value)editableRegion is set and type in (column!=Value)editableRegion is set and type in (columnIsContainedInValue)editableRegion is set and type in (columnIsNotContainedInValue)editableRegion is set and type in (columnContainsAtLeastOneOfCharsInValue)editableRegion is set and type in (columnContainsOnlyCharsInValue)editableRegion is set and type in (columnContainsNoneOfCharsInValue)
alwaysExecutebooleanYesfalsedata type=boolean
validation {
  editableRegion: @component
  type: rowsReturned
  sqlQuery: ```sql
    value
  ```
  language: sql
  sqlExpression: ```sql
    value
  ```
  plsqlExpression: ```plsql
    value
  ```
  javaScriptExpression: ```javascript-mle
    value
  ```
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  plsqlCodeRaisingError: ```plsql
    value
  ```
  item: value
  regexp: value
  value: ```
    value
  ```
  column: value
  alwaysExecute: false
}
advanced
PropertyTypeRequiredDefault ValueDetails
staticIdstringYesdata type=string; maxLen=255
advanced {
  staticId: value
}
error
PropertyTypeRequiredDefault ValueDetails
errorMessagemultiline stringYesdata type=multiline string; maxLen=4000
Applies wheneditableRegion is set
displayLocationenumYesinlineWithFieldAndInNotificationdata type=string; lov=STATIC
Valid values: inlineWithFieldAndInNotification inlineWithField inlineInNotification onErrorPage
associatedItemreferenceNodata type=reference; lov=COMPONENT; references=pageItem
associatedColumnstringNodata type=string; maxLen=255
Applies wheneditableRegion is set
error {
  errorMessage: ```
    value
  ```
  displayLocation: inlineWithFieldAndInNotification
  associatedItem: @component
  associatedColumn: value
}
serverSideCondition
PropertyTypeRequiredDefault ValueDetails
whenButtonPressedreferenceNodata type=reference; lov=COMPONENT; references=button
executionScopeenumYesforCreatedAndModifiedRowsdata type=string; lov=STATIC
Valid values: forCreatedAndModifiedRows allSubmittedRows
Applies wheneditableRegion is set
typeenumNodata type=string; lov=STATIC
Valid values: always rowsReturned noRowsReturned expression functionBody request=Value request!=Value requestIsContainedInValue requestIsNotContainedInValue item=value item!=value itemIsNull itemIsNotNull itemIsZero itemIsNotZero itemIsNullOrZero itemIsNotNullAndNotZero itemContainsNoSpaces itemIsNumeric itemIsNotNumeric itemIsAlphanumeric itemIsInColonDelimitedList itemIsNotInColonDelimitedList textIsContainedInItem text=value text!=value textIsContainedInValue textIsNotContainedInValue userPreference=value userPreference!=value currentPage=page currentPage!=page currentPageInList currentPageNotInList currentPage=pageSubmitted currentPage!=pageSubmitted currentPageIsInPrinterFriendlyMode currentPageIsNotInPrinterFriendlyMode pageRegionIsReadOnly pageRegionIsNotReadOnly userIsAuthenticated userIsPublicUser inlineValidationErrorsDisplayed inlineValidationErrorsNotDisplayed sqlReportsOkToShowForwardButton sqlReportsOkToShowBackButton currentLanguage=value currentLanguage!=value currentLanguageIsContainedInValue currentLanguageIsNotContainedInValue clientBrowserIsMozilla clientBrowserIsIE7higher clientBrowserIsXhtmlCssCapable clientBrowserIsOther cgiEnvDadName=value cgiEnvDadName!=value cgiEnvServerName=value cgiEnvServerName!=value cgiEnvHttpHost=value cgiEnvHttpHost!=value never
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype in (rowsReturned)type in (noRowsReturned)
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies whentype = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = functionBody and language = javaScript-mle
valuestringYesdata type=string; maxLen=4000
Applies whentype in (request=Value)type in (request!=Value)type in (requestIsContainedInValue)type in (requestIsNotContainedInValue)type in (currentLanguageIsContainedInValue)type in (currentLanguageIsNotContainedInValue)type in (currentLanguage!=value)type in (currentLanguage=value)type in (cgiEnvDadName=value)type in (cgiEnvDadName!=value)type in (cgiEnvServerName=value)type in (cgiEnvServerName!=value)type in (cgiEnvHttpHost=value)type in (cgiEnvHttpHost!=value)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype in (item=value)type in (item!=value)type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2)type in (itemIsNull)type in (itemIsNotNull)type in (itemIsZero)type in (itemIsNotZero)type in (itemIsNullOrZero)type in (itemIsNotNullAndNotZero)type in (itemContainsNoSpaces)type in (itemIsNumeric)type in (itemIsNotNumeric)type in (itemIsAlphanumeric)type in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList)
preferencestringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype in (userPreference=value)type in (userPreference!=value)
pageintegerYesdata type=integer; maxLen=4000
Applies whentype in (currentPage=page)type in (currentPage!=page)
pagesarray of integersYesdata type=integer; maxLen=4000
Applies whentype in (currentPageInList)type in (currentPageNotInList)
textstringYesdata type=string; maxLen=4000
Applies whentype in (textIsContainedInItem)type in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=value)
valuestringYesdata type=string; maxLen=4000
Applies whentype in (item=value)type in (item!=value)type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2)
listarray of stringsYesdata type=string; maxLen=4000
Applies whentype in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype = textIsContainedInItem
valuestringYesdata type=string; maxLen=4000
Applies whentype in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=value)
executeConditionenumYesforEachRowdata type=string; lov=STATIC
Valid values: forEachRow once
Applies wheneditableRegion is set and type is set
serverSideCondition {
  whenButtonPressed: @component
  executionScope: forCreatedAndModifiedRows
  type: always
  sqlQuery: ```sql
    value
  ```
  language: sql
  sqlExpression: ```sql
    value
  ```
  plsqlExpression: ```plsql
    value
  ```
  javaScriptExpression: ```javascript-mle
    value
  ```
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  value: value
  item: value
  preference: value
  page: 42
  pages: [
    42
    42
  ]
  text: value
  list: [
    value
    value
  ]
  executeCondition: forEachRow
}
security
PropertyTypeRequiredDefault ValueDetails
authorizationSchemeenumNodata type=reference; lov=COMPONENT; references=authorization
Valid values: mustNotBePublicUser
security {
  authorizationScheme: mustNotBePublicUser
}
config
PropertyTypeRequiredDefault ValueDetails
buildOptionreferenceNodata type=reference; lov=COMPONENT; references=buildOption
config {
  buildOption: @component
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
comments {
  comments: ```
    value
  ```
}

APEXlang Example

validation sample (
    name: value
    execution {
        sequence: 42
    }
    validation {
        editableRegion: @component
        type: rowsReturned
        sqlQuery: ```sql
          value
        ```
        language: sql
        sqlExpression: ```sql
          value
        ```
        plsqlExpression: ```plsql
          value
        ```
        javaScriptExpression: ```javascript-mle
          value
        ```
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        plsqlCodeRaisingError: ```plsql
          value
        ```
        item: value
        regexp: value
        value: ```
          value
        ```
        column: value
        alwaysExecute: false
    }
    advanced {
        staticId: value
    }
    error {
        errorMessage: ```
          value
        ```
        displayLocation: inlineWithFieldAndInNotification
        associatedItem: @component
        associatedColumn: value
    }
    serverSideCondition {
        whenButtonPressed: @component
        executionScope: forCreatedAndModifiedRows
        type: always
        sqlQuery: ```sql
          value
        ```
        language: sql
        sqlExpression: ```sql
          value
        ```
        plsqlExpression: ```plsql
          value
        ```
        javaScriptExpression: ```javascript-mle
          value
        ```
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        value: value
        item: value
        preference: value
        page: 42
        pages: [
          42
          42
        ]
        text: value
        list: [
          value
          value
        ]
        executeCondition: forEachRow
    }
    security {
        authorizationScheme: mustNotBePublicUser
    }
    config {
        buildOption: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)