Package com.blueriq.component.api

Class ProjectReference

java.lang.Object

com.blueriq.component.api.ProjectReference

All Implemented Interfaces:

IProjectReference, Serializable

Direct Known Subclasses:

Shortcut

public class ProjectReference
extends Object
implements IProjectReference

Mutable project reference implementation.

Since:

8.0

Author:

Danny Roest

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProjectReference(IProjectReference other)	Copy constructor
ProjectReference(String projectName)	Constructs a new application request for the specified application/project.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Map<String,String[]>	getAllParameters()	This method returns all the parameters set with with setParameters(Map).
String	getAquimaUi()
String	getChannel()
String	getFlow()
String	getLanguageCode()
String	getParameter(String name)	This method returns the request parameter set with setParameters(Map).
Map<String,String[]>	getParameters()	This method returns the request parameters set with setParameters(Map) without the standard request parameters ("project", "flow", "version", "languageCode", "ui", "theme", "channel").
String	getProjectName()
String	getTestPath()
String	getTheme()
String	getVersion()
int	hashCode()
boolean	hasPrivateAccess()	This method indicates if the project reference is private or not
boolean	isDevtoolsEnabled()
void	setAquimaUi(String aquimaUi)
void	setChannel(String channel)
void	setDevtoolsEnabled(boolean devtoolsEnabled)
void	setFlow(String flow)
void	setLanguageCode(String languageCode)
void	setParameters(Map<String,String[]> parameters)	This method sets the (additional) parameters from the request (often an httpServletRequest).
void	setPrivateAccess(boolean privateAccess)
void	setProjectName(String projectName)
void	setTestPath(String testPath)
void	setTheme(String theme)
void	setVersion(String version)
String	toString()
String	toUrl()
String	toUrl(Map<String,String[]> parameters)	This method returns the url to start this project reference.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProjectReference

public ProjectReference(String projectName)

Constructs a new application request for the specified application/project.

Parameters:

projectName - the name of the application/project

ProjectReference

public ProjectReference(IProjectReference other)

Copy constructor

Parameters:

other - The project reference to copy.

Method Detail

getProjectName

public String getProjectName()

Specified by:

getProjectName in interface IProjectReference

setProjectName

public void setProjectName(String projectName)

getVersion

public String getVersion()

Specified by:

getVersion in interface IProjectReference

setVersion

public void setVersion(String version)

getTheme

public String getTheme()

Specified by:

getTheme in interface IProjectReference

setTheme

public void setTheme(String theme)

getLanguageCode

public String getLanguageCode()

Specified by:

getLanguageCode in interface IProjectReference

setLanguageCode

public void setLanguageCode(String languageCode)

getChannel

public String getChannel()

Specified by:

getChannel in interface IProjectReference

setChannel

public void setChannel(String channel)

getFlow

public String getFlow()

Specified by:

getFlow in interface IProjectReference

setFlow

public void setFlow(String flow)

getAquimaUi

public String getAquimaUi()

Specified by:

getAquimaUi in interface IProjectReference

setAquimaUi

public void setAquimaUi(String aquimaUi)

getTestPath

public String getTestPath()

Specified by:

getTestPath in interface IProjectReference

setTestPath

public void setTestPath(String testPath)

isDevtoolsEnabled

public boolean isDevtoolsEnabled()

Specified by:

isDevtoolsEnabled in interface IProjectReference

setDevtoolsEnabled

public void setDevtoolsEnabled(boolean devtoolsEnabled)

hasPrivateAccess

public boolean hasPrivateAccess()

Description copied from interface: IProjectReference

This method indicates if the project reference is private or not

Specified by:

hasPrivateAccess in interface IProjectReference

Returns:

a boolean value

setPrivateAccess

public void setPrivateAccess(boolean privateAccess)

toUrl

public String toUrl()

toUrl

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

Description copied from interface: IProjectReference

This method returns the url to start this project reference.

Specified by:

toUrl in interface IProjectReference

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

public Map<String,String[]> getAllParameters()

This method returns all the parameters set with with setParameters(Map).

Specified by:

getAllParameters in interface IProjectReference

Returns:

a map all with the parameters

getParameters

public Map<String,String[]> getParameters()

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

Specified by:

getParameters in interface IProjectReference

Returns:

a map with the parameters

setParameters

public void setParameters(Map<String,String[]> parameters)

This method sets the (additional) parameters from the request (often an httpServletRequest). These parameters can be used as parameters for a flow.

Parameters:

parameters - the parameters

getParameter

public String getParameter(String name)

This method returns the request parameter set with setParameters(Map). If the parameters contains multiple values, the first will be returned.

Specified by:

getParameter in interface IProjectReference

Parameters:

name - The name of the parameter.

Returns:

The single value parameter, may be null.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object