com.sap.netweaver.coll.shared.api.extension

Interface IExtensionResult

All Superinterfaces:
IExtensionContext

public interface IExtensionResult
extends IExtensionContext

Interface describing a result of an extension. It inherits a context that transports parameter values after an extension has been processed, and adds a return code.


Field Summary
static int ERROR
           
static int OK
           
static int PARAMETER_MISSING
           
 
Method Summary
 Exception getException()
          Get the exception if the return code is on ERROR.
 String getMissingParameterId()
          Get the id of the parameter that is missing.
 int getReturnCode()
          Get the return code of the result.
 
Methods inherited from interface com.sap.netweaver.coll.shared.api.extension.IExtensionContext
addContext, getOptionalValue, getParameters, getType, getValue, isReference, putValue, putValue, putValue, setReference, setType, size
 

Field Detail

OK

public static final int OK
See Also:
Constant Field Values

ERROR

public static final int ERROR
See Also:
Constant Field Values

PARAMETER_MISSING

public static final int PARAMETER_MISSING
See Also:
Constant Field Values
Method Detail

getReturnCode

public int getReturnCode()
Get the return code of the result. If the return code is ERROR, the result contains a parameter with id EXCEPTION to retrieve the exception that occured while the extension was processed.

Returns:
The return code

getException

public Exception getException()
Get the exception if the return code is on ERROR.

Returns:
The Excpetion if if the return code is on ERROR, or null

getMissingParameterId

public String getMissingParameterId()
Get the id of the parameter that is missing.

Returns:
The parameter id


Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.