nextapp.echo.webcontainer
Interface CommandSynchronizePeer

All Known Implementing Classes:

AbstractCommandSynchronizePeer, BrowserOpenWindowCommandPeer, BrowserRedirectCommandPeer

public interface CommandSynchronizePeer

A stateless peer object used to render the given type of nextapp.echo.app.Command to the client.

A single instance of a given CommandSynchronizePeer will be created to synchronize the state of ALL instances of a particular class of Command. Thus, it is not possible to store information about a command's state in this object.

Method Summary

java.lang.String	getClientCommandType() Returns the remote client component name.
java.lang.Class	getCommandClass() Returns the Class of Command supported by this peer.
java.lang.Object	getProperty(nextapp.echo.app.util.Context context, nextapp.echo.app.Command command, java.lang.String propertyName, int propertyIndex) Returns the value of a specific property.
java.util.Iterator	getPropertyIndices(nextapp.echo.app.util.Context context, nextapp.echo.app.Command command, java.lang.String propertyName) Determines which indices of a particular property are set.
java.util.Iterator	getPropertyNames(nextapp.echo.app.util.Context context, nextapp.echo.app.Command command) Returns an Iterator over the collection of names of all output properties that should be rendered to the remote client.
void	init(nextapp.echo.app.util.Context context) Initializes the peer.
boolean	isPropertyIndexed(nextapp.echo.app.util.Context context, nextapp.echo.app.Command command, java.lang.String propertyName) Determines if the specified output property is indexed.

Method Detail

getClientCommandType

java.lang.String getClientCommandType()

Returns the remote client component name.

getCommandClass

java.lang.Class getCommandClass()

Returns the Class of Command supported by this peer.

Returns:

the Class

getProperty

java.lang.Object getProperty(nextapp.echo.app.util.Context context,
                             nextapp.echo.app.Command command,
                             java.lang.String propertyName,
                             int propertyIndex)

Returns the value of a specific property.

Parameters:

context - the relevant Context, provides standard contextual information described in class description, in addition to the following:

• ServerMessage

command - the Command being rendered

propertyName - the name of the property being rendered

propertyIndex - the property index (only relevant for indexed properties, -1 will be provided for non-indexed properties)

Returns:

the property value

getPropertyIndices

java.util.Iterator getPropertyIndices(nextapp.echo.app.util.Context context,
                                      nextapp.echo.app.Command command,
                                      java.lang.String propertyName)

Determines which indices of a particular property are set. This method will only be invoked on properties where isPropertyIndexed() has returned true.

Parameters:

context - the relevant Context, provides standard contextual information described in class description, in addition to the following:

• ServerMessage

command - the command

propertyName - the property name

Returns:

an Iterator that returns the set indices in incrementing order as Integers

getPropertyNames

java.util.Iterator getPropertyNames(nextapp.echo.app.util.Context context,
                                    nextapp.echo.app.Command command)

Returns an Iterator over the collection of names of all output properties that should be rendered to the remote client. Only the names of properties with non-default values should be returned.

Parameters:

context - the relevant Context, provides standard contextual information described in class description, in addition to the following:

• ServerMessage

command - the command

Returns:

an Iterator of property names

init

void init(nextapp.echo.app.util.Context context)

Initializes the peer. This method will be invoked prior to rendering a specific Command for the first time.

Parameters:

context - the relevant Context, provides standard contextual information described in class description, in addition to the following:

• ServerMessage

isPropertyIndexed

boolean isPropertyIndexed(nextapp.echo.app.util.Context context,
                          nextapp.echo.app.Command command,
                          java.lang.String propertyName)

Determines if the specified output property is indexed.

Parameters:

context - the relevant Context, provides standard contextual information described in class description, in addition to the following:

• ServerMessage

command - the command

propertyName - the property name

Returns:

true if the property is indexed