|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.bea.portlet.GenericURL
com.bea.portlet.PostbackURL
com.bea.portlet.CustomEventURL
public class CustomEventURL
The CustomEventURL
creates a URL that, when clicked, tells the system to generate a custom event.
A CustomEventURL is targeted to the portlet that generated it, but the event itself is generated by the portal framework and is not marked as coming from any particular portlet. Any portlets listening for the event that restrict what portlets they are listening to will therefore not receive the event. <p/> The CustomEventURL should not be used inside of Java portlets (JSR168 / JSR286). To get equivalent functionality with a java portlet, use the javax.portlet.ActionURL class to generate an action URL to the portlet, then have the portlet's processAction() method send the event.
GenericURL
Field Summary |
---|
Fields inherited from class com.bea.portlet.GenericURL |
---|
COMMUNITY_ADMIN_FLAG_PARAM, COMMUNITY_DESKTOP, CONTROL_STATE_PARAM, CURRENT_PAGE, domain, DOMAIN, EVENT_NAME_PARAM, httpRequest, httpResponse, httpsDomain, LOADSTATE_PARAM, MODE_PARAM, PAGE_LABEL_PARAM, params, PATH, PORT, PORTLET_SUB_INSTANCE_ID, POSTBACK_PARAM, PREFIX, QUERY_STRING, SCHEME, SECURE_PORT, STATE_PARAM, TREE_OPTIMIZATION_PARAM, URL_COMPRESSION, WINDOW_LABEL_PARAM |
Constructor Summary | |
---|---|
protected |
CustomEventURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) Constructs a CustomEventURL. |
protected |
CustomEventURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String eventName) Constructs a CustomEventURL. |
protected |
CustomEventURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String eventName, boolean encodeEventName) Constructs a CustomEventURL. |
Method Summary | |
---|---|
Object |
clone() Returns a deep copy. |
static CustomEventURL |
createCustomEventURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) Returns a CustomEventURL. |
static CustomEventURL |
createCustomEventURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String eventName) Returns a CustomEventURL. |
static CustomEventURL |
createCustomEventURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String eventName, boolean encodeEventName) Returns a CustomEventURL. |
void |
setEventName(String eventName) Sets the event name. |
void |
setEventName(String eventName, boolean encodeEventName) Sets the event name. |
Methods inherited from class com.bea.portlet.PostbackURL |
---|
createPostbackURL, toString |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected CustomEventURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String eventName)
Constructs a CustomEventURL.
httpRequest
- HTTP requesthttpResponse
- HTTP responseeventName
- event nameprotected CustomEventURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)
Constructs a CustomEventURL.
httpRequest
- HTTP requesthttpResponse
- HTTP responseprotected CustomEventURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String eventName, boolean encodeEventName)
Constructs a CustomEventURL.
httpRequest
- HTTP requesthttpResponse
- HTTP responseeventName
- event nameencodeEventName
- true if the event name should be encodedMethod Detail |
---|
public static CustomEventURL createCustomEventURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)
Returns a CustomEventURL.
httpRequest
- HTTP requesthttpResponse
- HTTP responsepublic static CustomEventURL createCustomEventURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String eventName)
Returns a CustomEventURL.
httpRequest
- HTTP requesthttpResponse
- HTTP responseeventName
- event namepublic static CustomEventURL createCustomEventURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String eventName, boolean encodeEventName)
Returns a CustomEventURL.
httpRequest
- HTTP requesthttpResponse
- HTTP responseeventName
- event nameencodeEventName
- true if the event name should be encodedpublic void setEventName(String eventName, boolean encodeEventName)
Sets the event name.
eventName
- the custom event name to be firedencodeEventName
- true if the event name should be encodedpublic void setEventName(String eventName)
Sets the event name.
eventName
- the custom event name to be firedpublic Object clone()
Returns a deep copy.
clone
in class PostbackURL
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.