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

All Known Subinterfaces:

IExtensionResult

public interface IExtensionContext

Interface describing a context that transports parameters when an extension point is processed. The extension result is also a context.

Method Summary

void	addContext(IExtensionContext value) Add all parameters of a context to this context.
java.lang.Object	getOptionalValue(java.lang.String id) Retrieve the value of a parameter with id id.
java.util.Hashtable	getParameters() Get all parameters the context contaoins.
java.lang.Object	getValue(java.lang.String id) Retrieve the value of a parameter with id id.
boolean	isReference(java.lang.String id) Check if the parameter with id id is a parameter name referencing an other parameter.
void	putValue(java.lang.String id, java.lang.Object value) Add a parameter to the context.
void	putValue(java.lang.String id, java.lang.Object value, boolean isReference) Add a reference to a parameter to the context.
void	setReference(java.lang.String id, boolean isReference) Define if the parameter with id id is a parameter name referencing an other parameter.
int	size() Return the amount of parameters the context contaoins.

Method Detail

getValue

public java.lang.Object getValue(java.lang.String id)

Retrieve the value of a parameter with id id. Throws an exeption if the value is not available.

Parameters:

id - Id of the parameter

Returns:

The value

getOptionalValue

public java.lang.Object getOptionalValue(java.lang.String id)

Retrieve the value of a parameter with id id. Does not throw an exeption if the value is not available.

Parameters:

id - Id of the parameter

Returns:

The value

isReference

public boolean isReference(java.lang.String id)

Check if the parameter with id id is a parameter name referencing an other parameter.

Parameters:

id - Id of the parameter

Returns:

If the parameter is a reference

putValue

public void putValue(java.lang.String id,
                     java.lang.Object value)

Add a parameter to the context.

Parameters:

id - Id of the parameter

value - Value of the parameter

putValue

public void putValue(java.lang.String id,
                     java.lang.Object value,
                     boolean isReference)

Add a reference to a parameter to the context.

Parameters:

id - Id of the parameter

value - Name of the referenced parameter

setReference

public void setReference(java.lang.String id,
                         boolean isReference)

Define if the parameter with id id is a parameter name referencing an other parameter.

Parameters:

id - Id of the parameter

isReference - If the parameter is a reference

size

public int size()

Return the amount of parameters the context contaoins.

Returns:

Amount of parameters

getParameters

public java.util.Hashtable getParameters()

Get all parameters the context contaoins.

Returns:

Hashtable containing all parameters

addContext

public void addContext(IExtensionContext value)

Add all parameters of a context to this context.

Parameters:

value - The other context