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, java.io.Serializable

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

Method Summary

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

Method Detail

getId

java.lang.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

java.lang.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

java.lang.String getTypeId()

Retrieves the type of the parameter as defined in the model.

Returns:

a string representing the type of the parameter

getAllAttributes

java.util.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

java.lang.Object getAttribute(java.lang.String name)

Gets a specified attribute.

Parameters:

name - the name of the attribute.

Returns:

the value of the attribute.