|
Decision Center API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object ilog.rules.teamserver.model.permalink.IlrPermanentLinkHelper
public class IlrPermanentLinkHelper
A set of helper methods to get permanent links on Decision Center data.
Constructor Summary | |
---|---|
IlrPermanentLinkHelper(IlrSession session)
Constructs a new permanent link helper. |
|
IlrPermanentLinkHelper(IlrSession session,
Locale locale,
boolean anonymous)
Constructs a new permanent link helper using the Decision Center console default values. |
|
IlrPermanentLinkHelper(IlrSession session,
Locale locale,
String datasource,
String defaultContextPath,
String facesServletPath,
boolean absoluteURL,
String defaultServerName,
int defaultServerPort,
boolean defaultIsSecure)
Constructs a new permanent link helper. |
|
IlrPermanentLinkHelper(IlrSession session,
Locale locale,
String datasource,
String defaultContextPath,
String facesServletPath,
String defaultServerName,
int defaultServerPort,
boolean defaultIsSecure)
Constructs a new permanent link helper. |
Method Summary | |
---|---|
String |
getElementDetailsURL(String projectName,
IlrElementHandle element)
Gets the permanent link URL of the given project and element. |
String |
getElementDetailsURL(String projectName,
IlrElementHandle baseline,
IlrElementHandle element)
Gets the permanent link URL of the given project and element for a specific baseline. |
String |
getElementDetailsURL(String projectName,
String baselineName,
IlrElementHandle element)
Deprecated. Use getElementDetailsURL(String, IlrElementHandle, IlrElementHandle) |
String |
getElementDetailsURL(String projectName,
String baselineName,
IlrElementHandle element,
boolean identifyByPath)
Deprecated. Use getElementDetailsURL(String, IlrElementHandle, IlrElementHandle) |
String |
getElementURL(IlrElementHandle element,
IlrElementVersion version)
Gets the permanent link URL of the given element. |
String |
getElementVersionDetailsURL(String projectName,
IlrElementHandle baseline,
IlrElementHandle element,
IlrElementVersion version)
Gets the permanent link URL of the given project and element for a specific baseline and element version. |
String |
getElementVersionDetailsURL(String elementId,
Integer subArtifactIndex)
Gets the permanent link URL of the given element. |
String |
getElementVersionDetailsURL(String projectName,
String baselineName,
IlrElementHandle element,
IlrElementVersion version)
Deprecated. Use getElementVersionDetailsURL(String, IlrElementHandle, IlrElementHandle, IlrElementVersion) . |
String |
getElementVersionDetailsURL(String projectName,
String baselineName,
IlrElementHandle element,
IlrElementVersion version,
boolean identifyByPath)
Deprecated. Use getElementVersionDetailsURL(String, IlrElementHandle, IlrElementHandle, IlrElementVersion) |
String |
getProjectURL(String projectName)
Gets the project URL. |
String |
getProjectURL(String projectName,
IlrElementHandle baseline)
Gets the permanent link URL of the given project for a specific baseline leading to the Decision Center Home page. |
String |
getProjectURL(String projectName,
String baselineName)
Deprecated. Use getProjectURL(String, IlrElementHandle) . |
String |
getReportURL(String projectName)
Gets the permanent link URL of the given project report. |
String |
getReportURL(String projectName,
IlrElementHandle baseline)
Gets the permanent link URL of the given project report for a specific baseline leading to the Decision Center Home page. |
String |
getReportURL(String projectName,
String baselineName)
Deprecated. Use getReportURL(String, IlrElementHandle) . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IlrPermanentLinkHelper(IlrSession session)
session
- The session from which the link is going to be built. Can be null. If not null, the first part
of the console URL will be built using the following configuration parameters:
public IlrPermanentLinkHelper(IlrSession session, Locale locale, boolean anonymous)
The context path and servlet path are set to the default values of the JRules distribution. The datasource is taken from the datasource of the given session.
session
- The session from which the link is going to be built. Can be null. If not null, the first part
of the console URL will be built using the following configuration parameters:
locale
- The locale in which the referenced resource will be displayed.anonymous
- Tells whether this link must be generated for anonymous users or not. Note that the anonymous mode
needs to be enabled otherwise the generated links will not work.public IlrPermanentLinkHelper(IlrSession session, Locale locale, String datasource, String defaultContextPath, String facesServletPath, String defaultServerName, int defaultServerPort, boolean defaultIsSecure)
session
- The session from which the link is going to be built. Can be null. If not null, the first part
of the console URL will be built using the following configuration parameters:
locale
- The locale in which the referenced resource will be displayed.datasource
- The datasource to access. If null, the default datasource will be used.defaultContextPath
- The context path of the resource. For example: /teamserver.facesServletPath
- The path of the Faces servlet as per WEB-INF/web.xml. For example: /faces or /faces/anonymous.defaultServerName
- The name of the server to use if the session is null or no server name is specified in
the configuration parameters.defaultServerPort
- The port of the server to use if the session is null or no server port is specified in
the configuration parameters.defaultIsSecure
- Tells whether the page must be accessed in a secured way or not (http and https).public IlrPermanentLinkHelper(IlrSession session, Locale locale, String datasource, String defaultContextPath, String facesServletPath, boolean absoluteURL, String defaultServerName, int defaultServerPort, boolean defaultIsSecure)
session
- The session from which the link is going to be built. Can be null. If not null, the first part
of the console URL will be built using the following configuration parameters:
locale
- The locale in which the referenced resource will be displayed.datasource
- The datasource to access. If null, the default datasource will be used.defaultContextPath
- The context path of the resource. For example: /teamserver.absoluteURL
- If true the generated links will be absolute (with hostname and port), if false the generated URLs will begin by the RTS context.facesServletPath
- The path of the Faces servlet as per WEB-INF/web.xml. For example: /faces or /faces/anonymous.defaultServerName
- The name of the server to use if the session is null or no server name is specified in
the configuration parameters.defaultServerPort
- The port of the server to use if the session is null or no server port is specified in
the configuration parameters.defaultIsSecure
- Tells whether the page must be accessed in a secured way or not (http and https).Method Detail |
---|
public String getProjectURL(String projectName)
projectName
- The project name.
public String getProjectURL(String projectName, String baselineName)
getProjectURL(String, IlrElementHandle)
.
projectName
- The project name.baselineName
- The baseline name.
public String getProjectURL(String projectName, IlrElementHandle baseline)
projectName
- The project name.baseline
- The baseline.
public String getReportURL(String projectName)
projectName
- The project name.
public String getReportURL(String projectName, String baselineName)
getReportURL(String, IlrElementHandle)
.
projectName
- The project name.baselineName
- The baseline name.
public String getReportURL(String projectName, IlrElementHandle baseline)
projectName
- The project name.baseline
- The baseline.
public String getElementURL(IlrElementHandle element, IlrElementVersion version)
element
- The element.version
- The version.
public String getElementDetailsURL(String projectName, IlrElementHandle element)
projectName
- The project name.element
- The element.
public String getElementDetailsURL(String projectName, String baselineName, IlrElementHandle element)
getElementDetailsURL(String, IlrElementHandle, IlrElementHandle)
projectName
- The project name.baselineName
- The baseline name.element
- The element.
public String getElementDetailsURL(String projectName, IlrElementHandle baseline, IlrElementHandle element)
projectName
- The project name.baseline
- The baseline.element
- The element.
public String getElementDetailsURL(String projectName, String baselineName, IlrElementHandle element, boolean identifyByPath)
getElementDetailsURL(String, IlrElementHandle, IlrElementHandle)
projectName
- The project name.baselineName
- The baseline name.element
- The element.identifyByPath
-
public String getElementVersionDetailsURL(String projectName, String baselineName, IlrElementHandle element, IlrElementVersion version)
getElementVersionDetailsURL(String, IlrElementHandle, IlrElementHandle, IlrElementVersion)
.
projectName
- The project name.baselineName
- The baseline name.element
- The element.version
- The version.
public String getElementVersionDetailsURL(String projectName, IlrElementHandle baseline, IlrElementHandle element, IlrElementVersion version)
projectName
- The project name.baseline
- The baseline.element
- The element.version
- The version.
public String getElementVersionDetailsURL(String projectName, String baselineName, IlrElementHandle element, IlrElementVersion version, boolean identifyByPath)
getElementVersionDetailsURL(String, IlrElementHandle, IlrElementHandle, IlrElementVersion)
projectName
- The project name.baselineName
- The baseline name.element
- The element.version
- The version.
public String getElementVersionDetailsURL(String elementId, Integer subArtifactIndex)
elementId
- The element id.subArtifactIndex
- The artifact index (the DT row number for example).
|
Decision Center API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |