Results 

The IGenericCreatorResults object provides the following methods for retrieving information about the execution of the XML script:

●     getResult(): Indicates whether the XML script was executed successfully, meaning that all objects and actions were created or performed successfully.

●     getParsedNodes(): Returns an Enumeration of all the objects or actions defined in the XML script. Each object is a string that is either the PCD address of an object to create, delete or modify, or an action handler.

The following methods provide subsets of this Enumeration:

¡        getExecutedNodes(): Returns an Enumeration of all objects or actions defined in the XML script but were not labeled to be ignored.

Each <Context> element (which defines an object) or <Action> element can contain the ignore attribute, which indicates to the portal not to create the object or perform the action. You may want to set this attribute in order to re-use an XML script that was already run and make pinpoint changes to content that was already created using the file.

The following methods provide subsets of this Enumeration:

§         getSucceededNodes(): Returns an Enumeration of all objects and actions defined in the XML script that were successfully created or performed.

§         getFailedNodes(): Returns an Enumeration of all objects and actions defined in the XML script that failed to be created or performed because of an error.

¡        getIgnoredNodes(): Returns an Enumeration of all objects and actions defined in the XML script but that were labeled to be ignored.

¡        getValidationFailedNodes(): Returns an Enumeration of all objects and actions whose XML block was not properly coded, for example, because a required attribute was missing.

If the XML block for at least one object or action was not properly coded, the entire XML script is not executed and the status of the execution is set to failed.

●     getReport(): Provides information for debugging. The returned string is composed of a series of messages, one for each action or object defined in the XML. Each message is composed of the following fields, each separated by a space:

○     Status: Indicates whether the action was performed or the object was created successfully.

○     Action: Can be one of the following:

■      Validate: The message was generated while the XML for the current action or object was being validated.

■      Execute: The message was generated while an action was performed or object was being created.

■      Clean: The message was generated while an object was being deleted.

○     Name: Action handler or PCD address

○     Type: Action or object handler

○     Message Text