java.lang.Object
- ch.ivyteam.ivy.model.SimpleValueObject<String>
- - ch.ivyteam.ivy.model.value.WebLink

All Implemented Interfaces:

Serializable
```
public class WebLink
extends SimpleValueObject<String>
```
Value object which provides methods to handle a web link (aka URI or URL).
Example:
import ch.ivyteam.ivy.model.value.WebLink; WebLink link = new WebLink("http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi"); link.getRelative(); // /ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi link.getRelativeEncoded(); // /ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=gr%C3%BCezi link.getAbsolute(); // http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi link.getAbsoluteEncoded(); // http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=gr%C3%BCezi

Since:

6.6.2

See Also:

Serialized Form

API:

This is a public API.

Constructor Summary

Constructors
Constructor Description

WebLink(String absoluteUri)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getAbsolute()`	Example:
`String`	`getAbsoluteEncoded()`	Example:
`String`	`getRelative()`	Example:
`String`	`getRelativeEncoded()`	Example:
`URI`	`toUri()`

Methods inherited from class ch.ivyteam.ivy.model.SimpleValueObject
equals, hashCode, toString

- Constructor Detail
  - WebLink
```
public WebLink(String absoluteUri)
```
    API:
    
    This public API is available in IvyScript and Java. It has the visibility NOVICE.
- Method Detail
  - getRelative
```
public String getRelative()
```
    Example:
    import ch.ivyteam.ivy.model.value.WebLink; WebLink link = new WebLink("http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi"); link.getRelative(); // /ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi link.getRelativeEncoded(); // /ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=gr%C3%BCezi link.getAbsolute(); // http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi link.getAbsoluteEncoded(); // http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=gr%C3%BCezi
    
    Returns:
    
    the relative uri without protocol, hostname etc.
    
    API:
    
    This public API is available in IvyScript and Java. It has the visibility NOVICE.
  - getRelativeEncoded
```
public String getRelativeEncoded()
```
    Example:
    import ch.ivyteam.ivy.model.value.WebLink; WebLink link = new WebLink("http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi"); link.getRelative(); // /ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi link.getRelativeEncoded(); // /ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=gr%C3%BCezi link.getAbsolute(); // http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi link.getAbsoluteEncoded(); // http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=gr%C3%BCezi
    
    Returns:
    
    the encoded relative uri without protocol, hostname etc.
    
    API:
    
    This public API is available in IvyScript and Java. It has the visibility NOVICE.
  - getAbsolute
```
public String getAbsolute()
```
    Example:
    import ch.ivyteam.ivy.model.value.WebLink; WebLink link = new WebLink("http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi"); link.getRelative(); // /ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi link.getRelativeEncoded(); // /ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=gr%C3%BCezi link.getAbsolute(); // http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi link.getAbsoluteEncoded(); // http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=gr%C3%BCezi
    
    Returns:
    
    the absolute uri including protocol, host name etc.
    
    API:
    
    This public API is available in IvyScript and Java. It has the visibility NOVICE.
  - getAbsoluteEncoded
```
public String getAbsoluteEncoded()
```
    Example:
    import ch.ivyteam.ivy.model.value.WebLink; WebLink link = new WebLink("http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi"); link.getRelative(); // /ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi link.getRelativeEncoded(); // /ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=gr%C3%BCezi link.getAbsolute(); // http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=grüezi link.getAbsoluteEncoded(); // http://localhost/ivy/pro/Portal/SelfServiceBpm/14232C3D829C4D71/start.ivp?search=gr%C3%BCezi
    
    Returns:
    
    the encoded absolute uri including protocol, host name etc.
    
    API:
    
    This public API is available in IvyScript and Java. It has the visibility NOVICE.
  - toUri
```
public URI toUri()
```
    Returns:
    
    the link converted to an URI
    
    API:
    
    This public API is available in IvyScript and Java. It has the visibility NOVICE.

Class WebLink

Constructor Summary

Method Summary

Methods inherited from class ch.ivyteam.ivy.model.SimpleValueObject

Constructor Detail

WebLink

Method Detail

getRelative

getRelativeEncoded

getAbsolute

getAbsoluteEncoded

toUri