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(java.lang.String id, java.lang.String resourceBundle, java.lang.String nameKey, java.lang.String descriptionKey) Create a displayable object.
IExtensionResult	createExtensionResult(int returnCode) Create an extension result.
IParameterInfo	createInputParameterInfo(IDisplayable displayable, java.lang.Class parameterClass, java.lang.String valueSetProviderId, boolean isRequired) Create a parameter info.
IParameterInfo	createOutputParameterInfo(IDisplayable displayable, java.lang.Class parameterClass) Create a parameter info.
IParameterValue	createParameterValue(IDisplayable displayable, java.lang.Object value) Create an parameter value.
IParameterInfo	createSystemParameterInfo(java.lang.String id, java.lang.Class parameterClass, boolean isRequired) Create a parameter info.
IValueSet	createValueSet(IParameterValue[] values, boolean isExclusive) Create a value set.

Method Detail

createDisplayable

public IDisplayable createDisplayable(java.lang.String id,
                                      java.lang.String resourceBundle,
                                      java.lang.String nameKey,
                                      java.lang.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,
                                               java.lang.Class parameterClass,
                                               java.lang.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,
                                                java.lang.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(java.lang.String id,
                                                java.lang.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,
                                            java.lang.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,
                                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