authorization - APEXlang Reference

`authorization`

Parent: app

Plug-in Variants: existsSqlQuerytype = existsSqlQuery, isInRoleOrGrouptype = isInRoleOrGroup, isNotInRoleOrGrouptype = isNotInRoleOrGroup, itemEqualsValuetype = itemEqualsValue, itemIsNotNulltype = itemIsNotNull, itemIsNulltype = itemIsNull, itemNotEqualsValuetype = itemNotEqualsValue, notExistsSqlQuerytype = notExistsSqlQuery, plSqlFunctionBodytype = plSqlFunctionBody, preferenceEqualsValuetype = preferenceEqualsValue, preferenceNotEqualsValuetype = preferenceNotEqualsValue

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=255 Enter an unique name that identifies this authorization scheme.
`type`	`enum`	Yes		data type=`string`; lov=`PLUGINS` Valid values: `existsSqlQuery` `isInRoleOrGroup` `isNotInRoleOrGroup` `itemEqualsValue` `itemIsNotNull` `itemIsNull` `itemNotEqualsValue` `notExistsSqlQuery` `plSqlFunctionBody` `preferenceEqualsValue` `preferenceNotEqualsValue`

Property Groups:

error

Property	Type	Required	Default Value	Details
`errorMessage`	`multiline string`	No		data type=`multiline string`; maxLen=4000 This is the error text that displays when this authorization scheme is applied to a application or page. If the authorization scheme fails (that is, the current user fails the security check) then this text displays.

error {
  errorMessage: ```
    value
  ```
}

advanced

Property	Type	Required	Default Value	Details
`evaluationType`	`enum`	Yes	`perPageView`	data type=`string`; lov=`STATIC` Valid values: `perSession` `perPageView` `perComponent` `always`
`staticId`	`string`	Yes		data type=`string`; maxLen=255

advanced {
  evaluationType: perSession
  staticId: value
}

subscription

Property	Type	Required	Default Value	Details
`master`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`authorization`

subscription {
  master: @component
}

comments

Property	Type	Required	Default Value	Details
`comments`	`multiline string`	No		data type=`multiline string`; maxLen=4000

comments {
  comments: ```
    value
  ```
}

APEXlang Example

authorization sample (
    name: value
    type: existsSqlQuery
    error {
        errorMessage: ```
          value
        ```
    }
    advanced {
        evaluationType: perSession
        staticId: value
    }
    subscription {
        master: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)