LinkModel (openbis_standard_technologies SNAPSHOT-r1677241701 API)

java.lang.Object
- ch.systemsx.cisd.openbis.generic.shared.basic.dto.LinkModel

All Implemented Interfaces:

java.io.Serializable
```
public class LinkModel
extends java.lang.Object
implements java.io.Serializable
```
A model for reporting plug-ins of type DSS_LINK. It keeps the different parts of the URL separate so that users can easily use only the parts they need.
The url is broken into schemAndDomain, path, and query parameters. An example:
https://openbis.ethz.ch/datastore_server/2010093083732894?param1=482745¶m2=something
- https://openbis.ethz.ch [schemeAndDomain]
- datastore_server/2010093083732894 [path]
- param1=482745¶m2=something [parameters]
LinkModels returned by the server do not (necessarily) contain a sessionID. The client should provide the session Id to the LinkModel before using it.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class LinkModel.LinkParameter

Constructor Summary

Constructors
Constructor Description

LinkModel()
Default Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<LinkModel.LinkParameter>`	`getParameters()`
`java.lang.String`	`getPath()`
`java.lang.String`	`getSchemeAndDomain()`
`void`	`setParameters(java.util.List<LinkModel.LinkParameter> parameters)`	Set the parameters
`void`	`setPath(java.lang.String path)`	Set the path of the url
`void`	`setSchemeAndDomain(java.lang.String schemeAndDomain)`	Set the scheme and domain of the url
`void`	`setSessionId(java.lang.String sessionId)`	The session token is a special parameter and should be set this way.
`java.lang.String`	`trySessionId()`	The session token is a special parameter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LinkModel
```
public LinkModel()
```
    Default Constructor.
- Method Detail
  - setSchemeAndDomain
```
public void setSchemeAndDomain(java.lang.String schemeAndDomain)
```
    Set the scheme and domain of the url
    
    Parameters:
    
    schemeAndDomain - e.g., https://openbis.ethz.ch
  - getSchemeAndDomain
```
public java.lang.String getSchemeAndDomain()
```
  - setPath
```
public void setPath(java.lang.String path)
```
    Set the path of the url
    
    Parameters:
    
    path - e.g., datastore_server/2010093083732894
  - getPath
```
public java.lang.String getPath()
```
  - setParameters
```
public void setParameters(java.util.List<LinkModel.LinkParameter> parameters)
```
    Set the parameters
  - getParameters
```
public java.util.List<LinkModel.LinkParameter> getParameters()
```
  - setSessionId
```
public void setSessionId(java.lang.String sessionId)
```
    The session token is a special parameter and should be set this way.
  - trySessionId
```
public java.lang.String trySessionId()
```
    The session token is a special parameter. It is returned as one of the parameters by getParameters(), but it can be retrieved directly this way.