org.eclipse.stardust.engine.api.model
Interface FormalParameter

All Superinterfaces:
org.eclipse.stardust.engine.core.model.utils.Identifiable, org.eclipse.stardust.engine.core.model.utils.Nameable, Serializable

public interface FormalParameter
extends org.eclipse.stardust.engine.core.model.utils.Identifiable, org.eclipse.stardust.engine.core.model.utils.Nameable, Serializable


Method Summary
 Map getAllAttributes()
          Gets all the attributes defined for this model element.
 Object getAttribute(String name)
          Gets a specified attribute.
 String getDataId()
          Retrieves the dataId of the data used.
 org.eclipse.stardust.common.Direction getDirection()
          Gets the parameter direction.
 String getId()
          Gets the ID of this model element.
 String getName()
          Gets the name of this model element.
 String getTypeId()
          Retrieves the type of the parameter as defined in the model.
 

Method Detail

getId

String getId()
Gets the ID of this model element.

Model elements such as process definitions or roles are identified by their ID. The IDs of model elements are Strings being unique inside the containing scope of the model element and the model version. The meaning of containing scope can vary for different model element types, but is usually given by the corresponding factory method.

Specified by:
getId in interface org.eclipse.stardust.engine.core.model.utils.Identifiable
Returns:
the ID of the model element.

getName

String getName()
Gets the name of this model element.

Model elements have names which can be used to identify them in visual user interfaces.

Specified by:
getName in interface org.eclipse.stardust.engine.core.model.utils.Nameable
Returns:
the name of the model element.

getDirection

org.eclipse.stardust.common.Direction getDirection()
Gets the parameter direction.

Returns:
the parameter direction.

getTypeId

String getTypeId()
Retrieves the type of the parameter as defined in the model.

Returns:
a string representing the type of the parameter

getDataId

String getDataId()
Retrieves the dataId of the data used.

Returns:
the dataId.

getAllAttributes

Map getAllAttributes()
Gets all the attributes defined for this model element.

Returns:
a Map with name-value pairs containing the attributes defined at modelling time.

getAttribute

Object getAttribute(String name)
Gets a specified attribute.

Parameters:
name - the name of the attribute.
Returns:
the value of the attribute.


Copyright © 2017 Eclipse Stardust. All Rights Reserved.