Package com.aquima.web.service.dap

Class StartProjectServiceParameters

java.lang.Object

com.aquima.web.service.dap.StartProjectServiceParameters

public class StartProjectServiceParameters
extends Object

This class is responsible for parsing and validating the parameters required by StartProjectService.

Since:

9.8

Author:

Voicu Moldovan

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION
static final String	DATA
static final String	SHORTCUT_ATTRIBUTE
static final String	SHORTCUT_NAME

Constructor Summary

Constructors

Constructor	Description
StartProjectServiceParameters(com.aquima.interactions.portal.IServiceContext context)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	getActionName()	Returns the name of action to be performed: open the project in the same tab, in a new tab or just execute the project in the background without a UI.
com.aquima.interactions.portal.ITypedParameterValue[]	getData()
String	getShortcutAttribute()	Retrieves the String value of the service parameter ShortcutAttribute.
String	getShortcutName()	Retrieves the String value of the service parameter ShortcutName.
boolean	hasData()	Checks weather the optional service parameter Data was filled or not.
boolean	hasShortcutAttribute()	Checks if the service parameter ShortcutAttribute was specified.
boolean	hasShortcutName()	Checks if the service parameter ShortcutName was specified.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SHORTCUT_NAME

public static final String SHORTCUT_NAME

See Also:

• Constant Field Values

SHORTCUT_ATTRIBUTE

public static final String SHORTCUT_ATTRIBUTE

See Also:

• Constant Field Values

ACTION

public static final String ACTION

See Also:

• Constant Field Values

DATA

public static final String DATA

See Also:

• Constant Field Values

Constructor Details

StartProjectServiceParameters

public StartProjectServiceParameters(com.aquima.interactions.portal.IServiceContext context)

Creates a new instance.

Parameters:

context - The context of the StartProjectServiceWrapper.

Method Details

hasShortcutName

public boolean hasShortcutName()

Checks if the service parameter ShortcutName was specified.

Returns:

true if the parameter ShortcutName was specified, false otherwise.

getShortcutName

public String getShortcutName()

Retrieves the String value of the service parameter ShortcutName. Before calling this method, it is recommended to check the ShortcutName value first by calling hasShortcutName() method.

Returns:

The actual value. It might be null.

hasShortcutAttribute

public boolean hasShortcutAttribute()

Checks if the service parameter ShortcutAttribute was specified.

Returns:

true if the parameter ShortcutAttribute was specified, false otherwise.

getShortcutAttribute

public String getShortcutAttribute()

Retrieves the String value of the service parameter ShortcutAttribute. Before calling this method, it is recommended to check the ShortcutAttribute value first by calling hasShortcutAttribute() method.

Returns:

The actual value. It might be null.

getActionName

public String getActionName()

Returns the name of action to be performed: open the project in the same tab, in a new tab or just execute the project in the background without a UI.

Returns:

the name of the action to be performed

hasData

public boolean hasData()

Checks weather the optional service parameter Data was filled or not.

Returns:

true if the parameter Data was set, false otherwise.

getData

public com.aquima.interactions.portal.ITypedParameterValue[] getData()

Returns:

Data parameter as array of ITypedParameterValue.