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

Interface IExtensionBuilderFactory


public interface IExtensionBuilderFactory

Interface describing a facory that produces the required objects to build an extension.


Method Summary
 IDisplayable createDisplayable(String id, String resourceBundle, String nameKey, String descriptionKey)
          Create a displayable object.
 IExtensionResult createExtensionResult(int returnCode)
          Create an extension result.
 IParameterInfo createInputParameterInfo(IDisplayable displayable, Class parameterClass, String valueSetProviderId, boolean isRequired)
          Create a parameter info.
 IParameterInfo createOutputParameterInfo(IDisplayable displayable, Class parameterClass)
          Create a parameter info.
 IParameterValue createParameterValue(IDisplayable displayable, Object value)
          Create an parameter value.
 IParameterInfo createSystemParameterInfo(String id, Class parameterClass, boolean isRequired)
          Create a parameter info.
 IValueSet createValueSet(IParameterValue[] values, boolean isExclusive)
          Deprecated.  
 IValueSet createValueSet(IParameterValue[] values, IParameterValue defaultValue, boolean isExclusive)
          Create a value set.
 IExtensionPoint[] getExtensionPoints()
          List all extension points.
 

Method Detail

createDisplayable

public IDisplayable createDisplayable(String id,
                                      String resourceBundle,
                                      String nameKey,
                                      String descriptionKey)
Create a displayable object.

Parameters:
id - Unique id of the parameter info
resourceBundle - Resource bundle that contains the localisation for name and description
nameKey - Key tho find the name in the resource bundle
descriptionKey - Key to find the description in the resource bundle
Returns:
The parameter info

createInputParameterInfo

public IParameterInfo createInputParameterInfo(IDisplayable displayable,
                                               Class parameterClass,
                                               String valueSetProviderId,
                                               boolean isRequired)
Create a parameter info.

Parameters:
displayable - Displayable implemeting id, name and description
parameterClass - Class of the parameter
valueSetProviderId - Id of the value se provider
isRequired - If the parameter is required or optional
Returns:
The parameter info

createOutputParameterInfo

public IParameterInfo createOutputParameterInfo(IDisplayable displayable,
                                                Class parameterClass)
Create a parameter info.

Parameters:
displayable - Displayable implemeting id, name and description
parameterClass - Class of the parameter
Returns:
The parameter info

createSystemParameterInfo

public IParameterInfo createSystemParameterInfo(String id,
                                                Class parameterClass,
                                                boolean isRequired)
Create a parameter info.

Parameters:
id - Unique id of the parameter info
isRequired - If the parameter is required or optional
Returns:
The parameter info

createParameterValue

public IParameterValue createParameterValue(IDisplayable displayable,
                                            Object value)
Create an parameter value.

Parameters:
displayable - Displayable implemeting id, name and description
value - The value
Returns:
The parameter value

createExtensionResult

public IExtensionResult createExtensionResult(int returnCode)
Create an extension result.

Parameters:
returnCode - Defines if the processing was correct or is on error
Returns:
The extension result

createValueSet

public IValueSet createValueSet(IParameterValue[] values,
                                IParameterValue defaultValue,
                                boolean isExclusive)
Create a value set.

Parameters:
isExclusive - Defines if the value set is complete or if other values ca be used
Returns:
The value set

getExtensionPoints

public IExtensionPoint[] getExtensionPoints()
List all extension points.

Returns:
The extension points

createValueSet

public IValueSet createValueSet(IParameterValue[] values,
                                boolean isExclusive)
Deprecated.  



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.