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.
Object	getOptionalValue(String id) Retrieve the value of a parameter with id id.
Hashtable	getParameters() Get all parameters the context contaoins.
String	getType(String id) Return the parameter type.
Object	getValue(String id) Retrieve the value of a parameter with id id.
boolean	isReference(String id) Deprecated.
void	putValue(String id, Object value) Add a parameter to the context.
void	putValue(String id, Object value, boolean isReference) Deprecated.
void	putValue(String id, String type, Object value) Add a reference to a parameter to the context.
void	setReference(String id, boolean isReference) Deprecated.
void	setType(String id, String type) Define if the type of the parameter with id id.
int	size() Return the amount of parameters the context contaoins.

Method Detail

getValue

Object getValue(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

Object getOptionalValue(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

getType

String getType(String id)

Return the parameter type.

Returns:

The type

isReference

boolean isReference(String id)

Deprecated.

putValue

void putValue(String id,
              Object value)

Add a parameter to the context.

Parameters:

id - Id of the parameter

value - Value of the parameter

putValue

void putValue(String id,
              String type,
              Object value)

Add a reference to a parameter to the context.

Parameters:

id - Id of the parameter

type - The type, taken from IParameterValue.type

value - Name of the referenced parameter

putValue

void putValue(String id,
              Object value,
              boolean isReference)

Deprecated.

setType

void setType(String id,
             String type)

Define if the type of the parameter with id id.

Parameters:

id - Id of the parameter

type - The type, taken from IParameterValue.type

setReference

void setReference(String id,
                  boolean isReference)

Deprecated.

size

int size()

Return the amount of parameters the context contaoins.

Returns:

Amount of parameters

getParameters

Hashtable getParameters()

Get all parameters the context contaoins.

Returns:

Hashtable containing all parameters

addContext

void addContext(IExtensionContext value)

Add all parameters of a context to this context.

Parameters:

value - The other context

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-COLL	[sap.com] tc/kmc/coll/room	api	EP-KM-CRS