com.axemble.vdoc.sdk.interfaces.runtime

Interface INavigateContext

All Superinterfaces:

Serializable

All Known Subinterfaces:

ILightboxContext

public interface INavigateContext
extends Serializable

A navigation context structure

Since:

2.1, 23/02/2011

Author:

vlygeros

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	INavigateContext.IType Navigation types.

Method Summary

Modifier and Type	Method and Description
INavigateContext	getCallerContext() Gets the caller navigate context.
String	getClassName() Gets the class name of the screen.
INavigateContext	getContext() Gets the inner context object.
String	getDisplayName() Gets the display name of the displayed object.
String	getMethodName() Gets the method name of the screen.
String	getObjectName() Gets the identifier of the displayed object.
Map<String,Object>	getParameterMap() Gets the named parameters.
Object	getParameterObject(String key) Gets a java.lang.Object parameter.
String	getParameterString(String key) Gets a java.lang.String parameter.
String[]	getParameterStrings(String key) Gets all the parameter's values from a key.
IProvider	getProvider() Gets the associated provider.
void	removeParameter(String key) Removes a parameter from the map.
void	setClassName(String className) Sets the class name of the screen.
void	setDisplayName(String displayName) Sets the display name of the displayed object.
void	setMethodName(String methodName) Sets the method name of the screen.
void	setObjectName(String objectName) Sets the identifier of the displayed object.
void	setParameter(String key, Object value) Sets a new object parameter.
void	setParameter(String key, String value) Sets a new string parameter.
void	setParameter(String key, String[] values) Sets several values for a specified key.
void	setParameters(Map<String,Object> map) Sets the named parameters map.

Method Detail

getClassName

String getClassName()

Gets the class name of the screen.

Returns:

A java.lang.String value.

setClassName

void setClassName(String className)

Sets the class name of the screen.

Parameters:

className - The class name of the screen.

getMethodName

String getMethodName()

Gets the method name of the screen.

Returns:

A java.lang.String value.

setMethodName

void setMethodName(String methodName)

Sets the method name of the screen.

Parameters:

methodName - The method name of the screen.

getObjectName

String getObjectName()

Gets the identifier of the displayed object.

Returns:

The identifier as a java.lang.String.

setObjectName

void setObjectName(String objectName)

Sets the identifier of the displayed object.

Parameters:

objectName - The identifier.

getDisplayName

String getDisplayName()

Gets the display name of the displayed object.

Returns:

A java.lang.String value.

setDisplayName

void setDisplayName(String displayName)

Sets the display name of the displayed object.

Parameters:

displayName - The display name to set.

getCallerContext

INavigateContext getCallerContext()

Gets the caller navigate context.

Returns:

A INavigateContext object.

getParameterMap

Map<String,Object> getParameterMap()

Gets the named parameters.

Returns:

A Map of parameters.

setParameters

void setParameters(Map<String,Object> map)

Sets the named parameters map.

Parameters:

map - The Map object to set.

getParameterString

String getParameterString(String key)

Gets a java.lang.String parameter.

Parameters:

key - The key of the parameter.

Returns:

The parameter as a java.lang.String value.

setParameter

void setParameter(String key,
                  String value)

Sets a new string parameter.

Parameters:

key - The key of the parameter.

value - The value of the parameter.

getParameterObject

Object getParameterObject(String key)

Gets a java.lang.Object parameter.

Parameters:

key - The key of the parameter.

Returns:

The parameter as a java.lang.Object value.

setParameter

void setParameter(String key,
                  Object value)

Sets a new object parameter.

Parameters:

key - The key of the parameter.

value - The value of the parameter.

getParameterStrings

String[] getParameterStrings(String key)

Gets all the parameter's values from a key.

Parameters:

key - The key of the parameter.

Returns:

An array of java.lang.String values.

setParameter

void setParameter(String key,
                  String[] values)

Sets several values for a specified key.

Parameters:

key - The key of the parameter.

values - The values to set.

removeParameter

void removeParameter(String key)

Removes a parameter from the map.

Parameters:

key - The key of the parameter.

getProvider

IProvider getProvider()

Gets the associated provider.

Returns:

A IProvider object.

getContext

INavigateContext getContext()

Gets the inner context object.

Returns:

A INavigateContext object.