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

Modifier and Type	Method and Description
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

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

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

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

IParameterInfo createSystemParameterInfo(String id,
                                         Class parameterClass,
                                         boolean isRequired)

Create a parameter info.

Parameters:

id - Unique id of the parameter info

parameterClass - Class of the parameter

isRequired - If the parameter is required or optional

Returns:

The parameter info

createParameterValue

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

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

IValueSet createValueSet(IParameterValue[] values,
                         IParameterValue defaultValue,
                         boolean isExclusive)

Create a value set.

Parameters:

values - Array of values

defaultValue - Default value of the parameter

isExclusive - Defines if the value set is complete or if other values ca be used

Returns:

The value set

getExtensionPoints

IExtensionPoint[] getExtensionPoints()

List all extension points.

Returns:

The extension points

createValueSet

IValueSet createValueSet(IParameterValue[] values,
                         boolean isExclusive)

Deprecated.

Parameters:

values - Array of values

isExclusive - Defines if the value set is complete or if other values ca be used

Returns:

The value set