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

Interface IParameterInfo

All Superinterfaces:

IDisplayable

public interface IParameterInfo

extends IDisplayable

Interface describing information about an extension parameter. This information can be displayed to interactively define rules how to compute the parameter values.

Nested Class Summary

static class

IParameterInfo.Type

Method Summary

Class	getParameterClass() Get the class of the parameter.
String	getType() Return the parameter type.
IValueSet	getValueSet(IExtensionContext context) Get the value set.
boolean	hasValueSet() Check if the parameter has a value set.
boolean	isRequired() Check if the parameter is required or optional.
boolean	isSystemParameter() Deprecated.

Methods inherited from interface com.sap.netweaver.coll.shared.api.extension.IDisplayable

getDescription, getId, getName

Method Detail

isRequired

public boolean isRequired()

Check if the parameter is required or optional.

Returns:

If the parameter is required

isSystemParameter

public boolean isSystemParameter()

Deprecated.

getType

public String getType()

Return the parameter type.

Returns:

The type

getParameterClass

public Class getParameterClass()

Get the class of the parameter.

Returns:

The class

hasValueSet

public boolean hasValueSet()

Check if the parameter has a value set.

Returns:

True if the parameter has a value set

getValueSet

public IValueSet getValueSet(IExtensionContext context)
                      throws Exception

Get the value set.

Parameters:

context - A context containig parameter values required to compute the value set, may be null

Returns:

The value set info

Throws:

Exception