CAS Programming Interface ($CACALL) › Action=NAVIGATE Class=PDOMAIN

Action=NAVIGATE Class=PDOMAIN

Determines the next panel to be displayed. You determine the panel by specifying the direction of movement (backward or forward) and the number of panels to skip, or by specifying the name of the panel domain element.

This statement has the following format:

&CONTROL SHRVARS=($PV,pref,...pref)
-EXEC $CACALL      OPT=ACTION
                   ACTION=NAVIGATE
                   CLASS=PDOMAIN
                   NAME='APPL=application id
                          [TYPE={PUBLIC | PRIVATE}]
                          [USER=userid]
                          NAME=domain name'
                   [PARMS='[CURRENT=element name]
                           [NEXT={element name | *}]
                           [SKIP={1 | n}]
                           [LOAD={YES | NO}]']

• APPL=application id

  A required parameter giving the application identifier of the panel domain.

• TYPE={PRIVATE | PUBLIC}

  An optional parameter giving the type of panel domain. Valid values are as follows:

  • PUBLIC

    Public domain—available for general use.

  • PRIVATE

    Private domain—owned by a specific user ID.

    Note: If you do not specify TYPE or USER, the function attempts to find the panel domain definition owned by the invoking user ID. If unsuccessful, the function uses a public panel domain definition.

• USER=userid

  An optional parameter (if TYPE=PRIVATE) giving the user ID of the user owning the PRIVATE panel domain. Default is the user ID of the user invoking the function.

• NAME=domain name

  A required parameter giving the name of the panel domain.

• CURRENT=element name

  An optional parameter indicating the current element. If this keyword is blank, the current element are assumed to be ##TOP## (if DIR=FORWARD) or ##END## (if DIR=BACKWARD).

  Note: DIR or SKIP is mutually exclusive to NEXT. If you do not specify DIR, NEXT, and SKIP, the default is DIR=FORWARD and SKIP=1.

• DIR={FORWARD | BACKWARD}

  An optional parameter indicating the direction in which navigation is to occur. The default is FORWARD.

• NEXT={element name | *}

  An optional parameter indicating the next element to progress to. If blank, the next element is determined based upon the defined paths (from the current element) and the direction of travel. If an element name is specified, navigation occurs to this element if it is currently eligible. If '*' is specified, a pick list of all eligible elements in the domain (excluding the element specified in the CURRENT= keyword) is presented.

• SKIP={1 | n}

  An optional parameter indicating the number of times to perform a panel navigation. The default is 1, and the range is 1 through 9999. Use this parameter when the user specifies a numeric or MAX scroll amount.

• LOAD={YES | NO}

  An optional parameter determining whether to load a domain if it is not currently loaded. The default is YES.