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

All Superinterfaces:

IDisplayable, IExtensionPoint

public interface IParameterInfo

extends IExtensionPoint

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

Method Summary

java.lang.Class	getParameterClass() Get the class of the parameter.
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() Check if the parameter is filled by the system or by interaction.

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

equals, hashCode

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()

Check if the parameter is filled by the system or by interaction.

Returns:

If the parameter is filled by the system

getParameterClass

public java.lang.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 java.lang.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