|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@StableMinor(version="6.2", sinceVersion="4.0") public interface IServiceInterfaceUrl
The ServiceInterfaceURL
interface represents a URL that reference the service
interface itself.
A ServiceInterfaceURL is created through the RenderResponse
. Parameters, a
service interface mode, a window state and a security level can be added to ServiceInterfaceURL
objects. The ServiceInterfaceURL must be converted to a String in order to embed it into the
markup generated by the service interface.
There are two types of ServiceInterfaceURLs:
RenderResponse.createActionURL
, and
trigger an action request followed by a render request.
RenderResponse.createRenderURL
, and
trigger a render request.
The string reprensentation of a ServiceInterfaceURL does not need to be a valid URL at the time the service interface is generating its content. It may contain special tokens that will be converted to a valid URL, by the portal, before the content is returned to the client.
Field Summary | |
---|---|
static int |
ACTION_URL
Comment for ACTION_URL
specifies that this url is an action url |
static int |
EXTERNAL_URL
Comment for EXTERNAL_URL
specifies that this url is an external url |
static int |
RENDER_URL
Comment for RENDER_URL
specifies that this url is a render url |
static int |
TARGET_SCOPE_PAGE
Comment for TARGET_SCOPE_PAGE
Send parameter to all interface instances in the target page. |
static int |
TARGET_SCOPE_SERVICE
Comment for TARGET_SCOPE_SERVICE
Send parameter to all interface instances in the target page that correspond to the specified
service. |
static int |
TARGET_SCOPE_SERVICEINSTANCE
Comment for TARGET_SCOPE_SERVICEINSTANCE
Send parameter to all interface instances in the target page that correspond to the specified
service instance. |
static int |
TARGET_SCOPE_SERVICEINTERFACE
Comment for TARGET_SCOPE_SERVICEINTERFACE
Send parameter to all interface instances in the target page that correspond to the specified
service interface. |
static int |
TARGET_SCOPE_SERVICEINTERFACEINSTANCE
Comment for TARGET_SCOPE_SERVICEINTERFACEINSTANCE
Send parameter to the interface instance in the target page that corresponds to the specified
interface interface. |
Method Summary | |
---|---|
String |
getUrl()
Deprecated. Since 4.0.7 this method was replaced by toString() method, so this
interface uses the same method as specified in the PortletURL interface. |
int |
getUrlType()
Returns the type of url. |
void |
setChannelId(String channelId)
Set the destination channel. |
void |
setExternalUrl(String url)
Set external url |
void |
setPageId(String pageId)
Set the destination page. |
void |
setRunTimeServiceInstanceId(String runTimeServiceInstanceId)
Sets the runtime service instance identifier. |
void |
setRunTimeServiceInterfaceId(String runTimeServiceInterfaceId)
Sets the runtime service interface identifier. |
void |
setTargetScope(int targetScope,
String targetId)
The target scope allows the service interface to send parameters to one or more service interfaces. |
String |
toString()
Returns the service interface URL string representation to be embedded in the markup. |
Methods inherited from interface javax.portlet.PortletURL |
---|
getPortletMode, getWindowState, removePublicRenderParameter, setPortletMode, setWindowState |
Methods inherited from interface javax.portlet.BaseURL |
---|
addProperty, getParameterMap, setParameter, setParameter, setParameters, setProperty, setSecure, write, write |
Field Detail |
---|
static final int TARGET_SCOPE_PAGE
TARGET_SCOPE_PAGE
Send parameter to all interface instances in the target page.
static final int TARGET_SCOPE_SERVICE
TARGET_SCOPE_SERVICE
Send parameter to all interface instances in the target page that correspond to the specified
service.
static final int TARGET_SCOPE_SERVICEINSTANCE
TARGET_SCOPE_SERVICEINSTANCE
Send parameter to all interface instances in the target page that correspond to the specified
service instance.
static final int TARGET_SCOPE_SERVICEINTERFACE
TARGET_SCOPE_SERVICEINTERFACE
Send parameter to all interface instances in the target page that correspond to the specified
service interface.
static final int TARGET_SCOPE_SERVICEINTERFACEINSTANCE
TARGET_SCOPE_SERVICEINTERFACEINSTANCE
Send parameter to the interface instance in the target page that corresponds to the specified
interface interface.
static final int ACTION_URL
ACTION_URL
specifies that this url is an action url
static final int RENDER_URL
RENDER_URL
specifies that this url is a render url
static final int EXTERNAL_URL
EXTERNAL_URL
specifies that this url is an external url
Method Detail |
---|
String getUrl() throws PortalException
toString()
method, so this
interface uses the same method as specified in the PortletURL
interface.
PortalException
String toString()
toString
in interface BaseURL
toString
in class Object
PortalException
void setPageId(String pageId)
pageId
- void setChannelId(String channelId)
channelId
- void setTargetScope(int targetScope, String targetId)
TARGET_SCOPE_SERVICE
TARGET_SCOPE_SERVICEINSTANCE
TARGET_SCOPE_SERVICEINTERFACE
TARGET_SCOPE_SERVICEINTERFACEINSTANCE
targetScope
- targetId
- void setExternalUrl(String url)
url
- void setRunTimeServiceInterfaceId(String runTimeServiceInterfaceId)
runTimeServiceInterfaceId
- void setRunTimeServiceInstanceId(String runTimeServiceInstanceId)
runTimeServiceInterfaceId
- int getUrlType()
RENDER_URL
, ACTION_URL
and EXTERNAL_URL
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |