Creating URLs to Components

You may want to create links between portal components by putting the URL of a portal component in a hyperlink tag (<a>). The Portal Runtime includes an API for creating URLs to portal components.

Note Note

Never hardcode URLs. Always use the API to create the URLs.

End of the note.

Procedure

Create a IPortalComponentURI object from the request object. This object is a helper class in creating the URL.
Syntax
1. ```
IPortalComponentURI componentURI = request.createPortalComponentURI();
```
End of the code.
Set the name of the component. In the example below, the link is to the portal component myApplication.myComponent.
Syntax
1. ```
componentURI.setContextName("myApplication" + "." + "myComponent");
```
End of the code.
Set the request event, if necessary.
Syntax
1. ```
IPortalRequestEvent myRequestEvent = request.createRequestEvent("myEvent");
```
2. ```
componentURI.setPortalRequestEvent(myRequestEvent);
```
End of the code.
You can add parameters in the request by adding an IPortalRequestEventData object - which contains key-value pairs - to the IPortalRequestEvent object.
Set the target of the request event, if necessary. In the example below, the target is the current component.
Syntax
1. ```
componentURI.setTargetNode(request.getNode());
```
End of the code.
Set the mode, if necessary.
Syntax
1. ```
componentURI.setNodeMode(NodeMode.EDIT_MODE);
```
End of the code.
Create the URL string with the following:
Syntax
1. ```
componentURI.toString();
```
End of the code.