com.sap.portal.genericcreator

Interface IGenericCreatorResults


public interface IGenericCreatorResults

The interface that indicates the results of executing an XML script, and contains the IDs of all the nodes that were parsed.

A node represents a PCD object or action defined in the XML. The ID is the PCD address of the object or the action handler.


Method Summary
 Enumeration getExecutedNodes()
          Returns the nodes that were executed.
 Enumeration getFailedNodes()
          Returns the nodes that failed to execute.
 Enumeration getIgnoredNodes()
          Returns the nodes that were ignored.
 Enumeration getParsedNodes()
          Returns the nodes that were parsed.
 String getReport()
          Returns a report that indicates the result of executing the XML script.
 GenericCreatorResult getResult()
          Indicates whether the XML script has executed successfully.
 Enumeration getSucceededNodes()
          Returns the nodes that were executed successfully.
 Enumeration getValidationFailedNodes()
          Returns the nodes that failed validation.
 

Method Detail

getResult

GenericCreatorResult getResult()
Indicates whether the XML script has executed successfully.

Returns:
GenericCreatorResult.SUCCESS or GenericCreatorResult.FAILED

getParsedNodes

Enumeration getParsedNodes()
Returns the nodes that were parsed.

Returns:
the parsed nodes

getExecutedNodes

Enumeration getExecutedNodes()
Returns the nodes that were executed.

Returns:
the executed nodes

getIgnoredNodes

Enumeration getIgnoredNodes()
Returns the nodes that were ignored.

Returns:
the ignored nodes

getFailedNodes

Enumeration getFailedNodes()
Returns the nodes that failed to execute.

Returns:
the failed nodes

getSucceededNodes

Enumeration getSucceededNodes()
Returns the nodes that were executed successfully.

Returns:
the Succeeded nodes

getValidationFailedNodes

Enumeration getValidationFailedNodes()
Returns the nodes that failed validation.

Returns:
the nodes that failed validation

getReport

String getReport()
Returns a report that indicates the result of executing the XML script.

Returns:
the execution report
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-RUNTIME [sap.com] tc/ep/semantics/api api EP-PIN


Copyright 2011 SAP AG Complete Copyright Notice