|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.zkoss.zk.au.AuRequest
public class AuRequest
A request sent from the client to the server.
Field Summary | |
---|---|
static int |
BUSY_IGNORE
Indicates whether it can be ignored by the server when the server receives the same requests consecutively. |
static int |
DUPLICATE_IGNORE
Indicates whether it can be ignored by the server when the server receives the same requests consecutively. |
static int |
REPEAT_IGNORE
Indicates Whether it can be ignored by the server when the server receives the same requests that was not processed yet. |
Constructor Summary | |
---|---|
AuRequest(Desktop desktop,
java.lang.String cmd,
java.util.Map<java.lang.String,java.lang.Object> data)
Constructor for a general request sent from client. |
|
AuRequest(Desktop desktop,
java.lang.String uuid,
java.lang.String cmd,
java.util.Map<java.lang.String,java.lang.Object> data)
Constructor for a request sent from a component. |
Method Summary | |
---|---|
void |
activate()
Activates this request. |
boolean |
equals(java.lang.Object o)
|
java.lang.String |
getCommand()
Returns the command of this request, such as onClick. |
Component |
getComponent()
Returns the component that this request is applied for, or null if it applies to the whole page or a general request. |
java.util.Map<java.lang.String,java.lang.Object> |
getData()
Returns the data of this request. |
Desktop |
getDesktop()
Returns the desktop; never null. |
int |
getOptions()
Returns the options, a combination of BUSY_IGNORE ,
DUPLICATE_IGNORE and REPEAT_IGNORE . |
Page |
getPage()
Returns the page that this request is applied for, or null if this request is a general request -- regardless any page or component. |
java.lang.String |
getUuid()
Returns the UUID. |
int |
hashCode()
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int BUSY_IGNORE
public static final int REPEAT_IGNORE
public static final int DUPLICATE_IGNORE
Constructor Detail |
---|
public AuRequest(Desktop desktop, java.lang.String uuid, java.lang.String cmd, java.util.Map<java.lang.String,java.lang.Object> data)
desktop
- the desktop containing the component; never null.uuid
- the component ID (never null)cmd
- the command of the request (never null)data
- the data; might be null.public AuRequest(Desktop desktop, java.lang.String cmd, java.util.Map<java.lang.String,java.lang.Object> data)
cmd
- the command of the request (never null)data
- the data; might be null.Method Detail |
---|
public void activate() throws ComponentNotFoundException
Used internally to identify the component and page after an execution is activated. Applications rarely need to access this method.
ComponentNotFoundException
public java.lang.String getCommand()
public int getOptions()
BUSY_IGNORE
,
DUPLICATE_IGNORE
and REPEAT_IGNORE
.
public Desktop getDesktop()
public Page getPage()
public Component getComponent()
ComponentNotFoundException
- if the component is not foundpublic java.lang.String getUuid()
getComponent()
's getUuid()
.
However, they are not the same if the component of the UUID has been
merged (as a stub component, such as StubComponent
)
into another one.
public java.util.Map<java.lang.String,java.lang.Object> getData()
getData().getInt("")
.
See also ZK Client-side Reference: AU Requests: Server-side Processing
Notice that, since 5.0.4, this method never returns null. If no data at all, it simply returns an empty map.
public int hashCode()
hashCode
in class java.lang.Object
public final boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |