com.sssw.fw.api
Interface EbiScopedPath

All Superinterfaces:

Serializable

public interface EbiScopedPath

extends Serializable

A ScopedPath represents an get/set protocol that exposes the target object in an xpath like syntax. ScopedPaths can be read-write capabilities of the scope can also be controlled.

Method Summary

Node	getDefinition(EbiContext context) Returns an Document that describes the syntax of the scopedPath.
String	getScopedPath(EbiContext context) Returns a string that this scopedPath represents.
String	getSyntax() Returns a string representing the potential syntax of the scopedpath.
Object	getValue(EbiContext context) Returns an Object that is referenced by this scopedPath
boolean	isNode(EbiContext context) Returns a boolean indicating if the object this scopedPath references is of type org.w3c.dom.Node
boolean	isReadable() Returns a boolean indicating if this scopedPath type supports the "getValue" operation
boolean	isWriteable() Returns a boolean indicating if this scopedPath type supports the "setValue" operation
boolean	pathExists(EbiContext context) Returns a boolean indicating if this scopedPath references a non-null object
void	removeValue(EbiContext context) Removes or deletes the object referenced by this scopedPath
void	setScopedPath(String scopedPath) Sets the scopedPath string that this scopedPath represents.
void	setValue(EbiContext context, Object value) Sets the value of the object that this scopedPath represents.

Method Detail

getSyntax

public String getSyntax()

Returns a string representing the potential syntax of the scopedpath.

Returns:

a String indicating the syntax of the scopedpath, used for user information.

Since:

v5.0

setScopedPath

public void setScopedPath(String scopedPath)

Sets the scopedPath string that this scopedPath represents.

Parameters:

scopedPath - a String specifying the scopedPath

Since:

v5.0

getScopedPath

public String getScopedPath(EbiContext context)

Returns a string that this scopedPath represents.

Returns:

a String indicating the scopedPath

Since:

v5.0

isReadable

public boolean isReadable()

Returns a boolean indicating if this scopedPath type supports the "getValue" operation

Returns:

a boolean if this scope supports "getValue" operation

Since:

v5.0

isWriteable

public boolean isWriteable()

Returns a boolean indicating if this scopedPath type supports the "setValue" operation

Returns:

a boolean if this scope supports "setValue" operation

Since:

v5.0

pathExists

public boolean pathExists(EbiContext context)

Returns a boolean indicating if this scopedPath references a non-null object

Returns:

a boolean if this scope references a non-null object.

Since:

v5.0

isNode

public boolean isNode(EbiContext context)

Returns a boolean indicating if the object this scopedPath references is of type org.w3c.dom.Node

Returns:

a boolean indicating if the object this scopedPath references is of type org.w3c.dom.Node

Since:

v5.0

setValue

public void setValue(EbiContext context,
                     Object value)

Sets the value of the object that this scopedPath represents. null is a valid value, and should be check for.

Parameters:

context - a com.sssw.fw.api.EbiContext that contains the current running requests context information.

value - an Object, that should become the new value of the object that this scopedPath references.

Since:

v5.0

getValue

public Object getValue(EbiContext context)

Returns an Object that is referenced by this scopedPath

Returns:

an Object that is referenced by this scopedPath

Since:

v5.0

removeValue

public void removeValue(EbiContext context)

Removes or deletes the object referenced by this scopedPath

Since:

v5.0

getDefinition

public Node getDefinition(EbiContext context)

Returns an Document that describes the syntax of the scopedPath. For example, if you had a Foo scope, that supported the following syntax Foo/[bar|BAR] you would want to return a document that had a format similiar to: This document is shown during prompting within visual editors.

Returns:

an org.w3c.dom.Node, that represents the syntax document.

Since:

v5.0