Package com.blueriq.component.api

Interface IProjectReference

All Superinterfaces:

Serializable

All Known Subinterfaces:

IShortcut

All Known Implementing Classes:

DynamicShortcutReference, ProjectReference, Shortcut

public interface IProjectReference
extends Serializable

Represents an project request to start which can be put on the session.

Since:

9.0

Author:

Danny Roest, Jon van Leuven

Method Summary

Modifier and Type	Method	Description
Map<String,String[]>	getAllParameters()	This method returns all the parameters.
String	getAquimaUi()
String	getChannel()
String	getFlow()
String	getLanguageCode()
String	getParameter(String name)	This method returns the request parameter value.
Map<String,String[]>	getParameters()	This method returns the request parameters without the standard request parameters ("project", "flow", "version", "languageCode", "ui", "theme", "channel").
String	getProjectName()
String	getTestPath()
String	getTheme()
String	getVersion()
boolean	hasPrivateAccess()	This method indicates if the project reference is private or not
boolean	isDevtoolsEnabled()
String	toUrl(Map<String,String[]> parameters)	This method returns the url to start this project reference.

Method Detail

getProjectName

String getProjectName()

getVersion

String getVersion()

getTheme

String getTheme()

getLanguageCode

String getLanguageCode()

getChannel

String getChannel()

getFlow

String getFlow()

getAquimaUi

String getAquimaUi()

getTestPath

String getTestPath()

isDevtoolsEnabled

boolean isDevtoolsEnabled()

toUrl

String toUrl(Map<String,String[]> parameters)

This method returns the url to start this project reference.

Parameters:

parameters - The additional paramaters that should be added to the url, may be null.

Returns:

The url to start this project reference, never null.

getAllParameters

Map<String,String[]> getAllParameters()

This method returns all the parameters.

Returns:

a map all with the parameters

getParameters

Map<String,String[]> getParameters()

This method returns the request parameters without the standard request parameters ("project", "flow", "version", "languageCode", "ui", "theme", "channel").

Returns:

a map with the parameters

getParameter

String getParameter(String name)

This method returns the request parameter value. If the parameters contains multiple values, the first will be returned.

Parameters:

name - The name of the parameter.

Returns:

The single value parameter, may be null.

hasPrivateAccess

boolean hasPrivateAccess()

This method indicates if the project reference is private or not

Returns:

a boolean value