|
NextApp Echo3 v3.0.b4 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
java.lang.String getClientCommandType()
java.lang.Class getCommandClass()
Class
of Command
supported by this peer.
Class
java.lang.Object getProperty(nextapp.echo.app.util.Context context, nextapp.echo.app.Command command, java.lang.String propertyName, int propertyIndex)
context
- the relevant Context
, provides
standard contextual information described in class description, in
addition to the following:
command
- the Command
being renderedpropertyName
- the name of the property being renderedpropertyIndex
- the property index (only relevant for indexed properties, -1 will
be provided for non-indexed properties)
java.util.Iterator getPropertyIndices(nextapp.echo.app.util.Context context, nextapp.echo.app.Command command, java.lang.String propertyName)
isPropertyIndexed()
has returned true.
context
- the relevant Context
, provides
standard contextual information described in class description, in
addition to the following:
command
- the commandpropertyName
- the property name
Iterator
that returns the set indices in
incrementing order as Integer
sjava.util.Iterator getPropertyNames(nextapp.echo.app.util.Context context, nextapp.echo.app.Command command)
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.
context
- the relevant Context
, provides
standard contextual information described in class description, in
addition to the following:
command
- the command
Iterator
of property namesvoid init(nextapp.echo.app.util.Context context)
Command
for the first time.
context
- the relevant Context
, provides
standard contextual information described in class description, in
addition to the following:
boolean isPropertyIndexed(nextapp.echo.app.util.Context context, nextapp.echo.app.Command command, java.lang.String propertyName)
context
- the relevant Context
, provides
standard contextual information described in class description, in
addition to the following:
command
- the commandpropertyName
- the property name
|
NextApp Echo3 v3.0.b4 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |