org.eclipse.tigerstripe.workbench.model.deprecated_
Interface IMethod.IArgument

All Superinterfaces:

IStereotypeCapable

Enclosing interface:

IMethod

public static interface IMethod.IArgument
extends IStereotypeCapable

Method Summary

IMethod.IArgument	clone() Clone this argument.
java.lang.String	getComment() Returns the comment (or plain-english description) associated with this argument.
IAbstractArtifact	getContainingArtifact() Returns the IArtifact that is the "container" for the Argument.
IMethod	getContainingMethod() Returns the IMethod that is the "container" for the argument.
java.lang.String	getDefaultValue() Returns the default value for this argument if it is defined, null otherwise.
java.lang.String	getName() Returns the name associated with this argument.
int	getRefBy() Returns an integer value indicating the reference type of the argument.
java.lang.String	getRefByString() Returns an String value indicating the reference type of the argument.
IType	getType() Returns the type of this argument.
boolean	isOrdered() Returns true if the return of this argument contains ordered values.
boolean	isUnique() Returns true if the argument contains unique values.
void	setComment(java.lang.String description) Sets the comment for this argument.
void	setDefaultValue(java.lang.String defaultValue) Sets the default value fpor this argument.
void	setName(java.lang.String name) Set the name for this argument.
void	setOrdered(boolean isOrdered) Sets the ordered attribute for this argument.
void	setRefBy(int refBy) Set the reference type of the argument.
void	setType(IType type) Set the type of this argument.
void	setUnique(boolean isUnique) Sets the unique attribute for this argument.

Methods inherited from interface org.eclipse.tigerstripe.workbench.profile.stereotype.IStereotypeCapable

addStereotypeInstance, getAnnotation, getAnnotations, getAnnotations, getStereotypeInstanceByName, getStereotypeInstances, hasAnnotations, hasAnnotations, hasStereotypeInstance, removeStereotypeInstance, removeStereotypeInstances

Method Detail

getContainingArtifact

IAbstractArtifact getContainingArtifact()

Returns the IArtifact that is the "container" for the Argument. This will be the same as the IArtifact that is the container for the Method.

Returns:

the containing artifact.

getContainingMethod

IMethod getContainingMethod()

Returns the IMethod that is the "container" for the argument.

Returns:

the containing method.

getComment

java.lang.String getComment()

Returns the comment (or plain-english description) associated with this argument.

Returns:

String - the comment

setComment

void setComment(java.lang.String description)

Sets the comment for this argument.

Parameters:

description -

getName

java.lang.String getName()

Returns the name associated with this argument.

Returns:

String - the name of the argument

setName

void setName(java.lang.String name)

Set the name for this argument.

Parameters:

name -

isOrdered

boolean isOrdered()

Returns true if the return of this argument contains ordered values.

Returns:

setOrdered

void setOrdered(boolean isOrdered)

Sets the ordered attribute for this argument.

Parameters:

isOrdered -

isUnique

boolean isUnique()

Returns true if the argument contains unique values.

Returns:

setUnique

void setUnique(boolean isUnique)

Sets the unique attribute for this argument.

Parameters:

isUnique -

getType

IType getType()

Returns the type of this argument.

Returns:

IType - the type of this argument

setType

void setType(IType type)

Set the type of this argument.

Parameters:

type -

getRefBy

int getRefBy()

Returns an integer value indicating the reference type of the argument. Possible values are defined in the static fields of IField.

Returns:

int - the integer value corresponding to the refBy

setRefBy

void setRefBy(int refBy)

Set the reference type of the argument. Possible values are defined in the static fields of IField.

Parameters:

refBy -

getRefByString

java.lang.String getRefByString()

Returns an String value indicating the reference type of the argument. Possible values are defined in the refByLabels field of IField.

Returns:

String - the refBy type

getDefaultValue

java.lang.String getDefaultValue()

Returns the default value for this argument if it is defined, null otherwise.

Returns:

setDefaultValue

void setDefaultValue(java.lang.String defaultValue)

Sets the default value fpor this argument.

Parameters:

defaultValue -

clone

IMethod.IArgument clone()

Clone this argument.

Returns: