Back Forward Page-Change-Class method

Methods and instructions by function

Use this method to change the class of the top-level page identified in the Step Page column. (To change the class of an embedded page, see How to Change the Class of a Page.)

CautionBefore changing the class of a page, be sure that all properties referenced on the page are also defined in the target class (the destination class).

Parameters

This method has three parameters:

Parameter

Description

ObjClassNew

Identify the target or destination class of the page.

Model

Optional. Identify a model (in the target class or a superclass of that class) to apply to the page.

Keep

Optional. Enter 0, 1 or 2 to control the how properties are added to the page. If not specified, 0 is the default.

  • 0 causes the value of a property already present on the step page to be retained  — not overwritten — by a value for that property on the model rule.
  • 1 causes a property value on the model to overwrite a value already present on the step page.
  • 2 retains the values of properties already on the step page (as with 0), but with special treatment for Page List, Value List and Value Group properties, as described in the table.

Mode

Results with Keep 2

Page List

First, all model Page List elements are merged to the step page Page List.  (This is the same behavior as keep 0).

Then, if the step page Page List property contains more elements than the model Page List property, the first element of the model list is used as the value for all the remaining target list elements.  This differs from processing with Keep 0, which ignores the target pages beyond the size of the model list.

Value List and Value Group

If the step page contains the property but it is empty (contains no elements), the model property is copied — including all its elements — into the destination.  This differs from the Keep 0 behavior, as existing destination properties may be altered.

(other modes)

Same as Keep 0.

Results

The system creates a new page of the target class identified in the ObjClassNew parameter.

If a model is specified in the Model parameter, the system uses rule resolution to find the model, and uses it as described above.

The system copies properties from the existing step page to the new page, in accord with the Keep parameter.

The previous step page (with the previous class) is destroyed.

This method does not validate property values. The page name is unaltered. This method does update the pxMethodStatus property. See How to test method results using a transition.

Restrictions

This method cannot be used in a step that involves iteration.

zzzMethods and instructions by function