OperationParameter defines the base of operation parameters. More...

Public Member Functions
String	getDescription ()
	Returns the description of the element.
Class<?extends IAXLangElement >	getElementType ()
	Returns the element type.
List< String >	getExtensions ()
	Returns a list of valid file extensions for this parameter.
String	getID ()
	Returns the identifier.
ParameterTypes	getParameterType ()
	Returns the parameter type.
List< String >	getSelectionItems ()
	Returns a list of free selection items for this parameter.
String	getSelectionParent ()
	Returns the parent element of the selection.
Role	getSelectionRole ()
	Returns the selection role.
String	getShort ()
	Returns the short text for the element.
boolean	isMandatory ()
	Returns if the parameter is mandatory.
	OperationParameter (ParameterTypes newParameterType, String newID, String newShort)
	Constructor, initializes the operation parameter.
	OperationParameter (ParameterTypes newParameterType, String newID, String newShort, String newDescription, boolean isMandatory)
	Constructor, initializes the operation parameter.
	OperationParameter (ParameterTypes newParameterType, String newID)
	Constructor, initializes the operation parameter.
	OperationParameter (ParameterTypes newParameterType, String newID, String newShort, String newDescription)
	Constructor, initializes the operation parameter.
void	setElementType (Class<?extends IAXLangElement > newElementType)
	Sets the element type.
void	setExtensions (String...newExtensions)
	Sets the valid file extensions for this parameter.
void	setSelectionItems (String...newSelectionItems)
	Sets the free selection items for this parameter.
void	setSelectionParent (String newParent)
	Sets the parent element of the selection.
void	setSelectionRole (Role newRole)
	Sets the selection role.
Private Member Functions
void	init (ParameterTypes newParameterType, String newID, String newShort, String newDescription, boolean isMandatory)
	Initializes the operation parameter.
Private Attributes
boolean	bMandatory = false
	mandatory parameter?
List< String >	lstExtensions = null
	file extensions (sorted, therefore a list)
List< String >	lstSelectionItems = null
	free selection items (sorted, therefore a list)
String	sDescription = null
	short description of the parameter
String	sID = null
	identifier of the parameter
String	sSelectionParent = null
	parent element of selections
String	sShort = null
	short text for the parameter
Class<?extends IAXLangElement >	theElementType = null
	element type
ParameterTypes	theParameterType
	type of the parameter
Role	theSelectionRole = null
	role of the selection

Detailed Description

OperationParameter defines the base of operation parameters.

Author:: ekleinod

Version:: 0.9.0

Since:: 0.8.0

Constructor & Destructor Documentation

de.fraunhofer.isst.axbench.api.operations.OperationParameter.OperationParameter	(	ParameterTypes	newParameterType,
		String	newID
	)

Constructor, initializes the operation parameter.

Parameters:

	newParameterType	type of the operation parameter
	newID	identifier

de.fraunhofer.isst.axbench.api.operations.OperationParameter.OperationParameter	(	ParameterTypes	newParameterType,
		String	newID,
		String	newShort
	)

Constructor, initializes the operation parameter.

Parameters:

	newParameterType	type of the operation parameter
	newID	identifier
	newShort	short text

de.fraunhofer.isst.axbench.api.operations.OperationParameter.OperationParameter	(	ParameterTypes	newParameterType,
		String	newID,
		String	newShort,
		String	newDescription
	)

Constructor, initializes the operation parameter.

Parameters:

	newParameterType	type of the operation parameter
	newID	identifier
	newShort	short text
	newDescription	short description

de.fraunhofer.isst.axbench.api.operations.OperationParameter.OperationParameter	(	ParameterTypes	newParameterType,
		String	newID,
		String	newShort,
		String	newDescription,
		boolean	isMandatory
	)

Constructor, initializes the operation parameter.

Parameters:

	newParameterType	type of the operation parameter
	newID	identifier
	newShort	short text
	newDescription	short description
	isMandatory	mandatory?

Member Function Documentation

String de.fraunhofer.isst.axbench.api.operations.OperationParameter.getDescription ( )

Returns the description of the element.

Returns:: description of the element

Return values:

null

if no description is defined

Class<? extends IAXLangElement> de.fraunhofer.isst.axbench.api.operations.OperationParameter.getElementType ( )

Returns the element type.

Returns:: element type

Return values:

{@link

IAXLangElement} if none was set

List<String> de.fraunhofer.isst.axbench.api.operations.OperationParameter.getExtensions ( )

Returns a list of valid file extensions for this parameter.

The first extension is used as default extension.

Returns:: list of valid file extensions

Return values:

empty

list if none defined

String de.fraunhofer.isst.axbench.api.operations.OperationParameter.getID ( )

Returns the identifier.

Returns:: identifier of the operation parameter

ParameterTypes de.fraunhofer.isst.axbench.api.operations.OperationParameter.getParameterType ( )

Returns the parameter type.

Returns:: type of the operation parameter

List<String> de.fraunhofer.isst.axbench.api.operations.OperationParameter.getSelectionItems ( )

Returns a list of free selection items for this parameter.

Returns:: list of free selection items

Return values:

empty

list if none defined

String de.fraunhofer.isst.axbench.api.operations.OperationParameter.getSelectionParent ( )

Returns the parent element of the selection.

Returns:: parent element of selection

Role de.fraunhofer.isst.axbench.api.operations.OperationParameter.getSelectionRole ( )

Returns the selection role.

Returns:: role of the selection

String de.fraunhofer.isst.axbench.api.operations.OperationParameter.getShort ( )

Returns the short text for the element.

Returns:: short text for the element

Return values:

null

if no short text is defined

void de.fraunhofer.isst.axbench.api.operations.OperationParameter.init	(	ParameterTypes	newParameterType,
		String	newID,
		String	newShort,
		String	newDescription,
		boolean	isMandatory
	)			`[private]`