org.eclipse.tigerstripe.model
Interface IMethod.IArgument

All Superinterfaces:
IStereotypeCapable
Enclosing interface:
IMethod

public static interface IMethod.IArgument
extends IStereotypeCapable


Method Summary
 IMethod.IArgument clone()
           
 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 Method.
 IMethod getContainingIMethod()
          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.
 IType getIType()
          Returns the type of this argument.
 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.
 boolean isOrdered()
           
 boolean isUnique()
           
 void setComment(java.lang.String description)
           
 void setDefaultValue(java.lang.String defaultValue)
           
 void setIType(IType type)
           
 void setName(java.lang.String name)
           
 void setOrdered(boolean isOrdered)
           
 void setRefBy(int refBy)
          valid values are IField.REFBY_VALUE, IField.REFBY_KEY, IField.REFBY_KEYRESULT
 void setUnique(boolean isUnique)
           
 
Methods inherited from interface org.eclipse.tigerstripe.profile.stereotype.IStereotypeCapable
addStereotypeInstance, getStereotypeInstances, removeStereotypeInstance, removeStereotypeInstances
 

Method Detail

setDefaultValue

void setDefaultValue(java.lang.String defaultValue)

setComment

void setComment(java.lang.String description)

setName

void setName(java.lang.String name)

setOrdered

void setOrdered(boolean isOrdered)

setUnique

void setUnique(boolean isUnique)

setIType

void setIType(IType type)

setRefBy

void setRefBy(int refBy)
valid values are IField.REFBY_VALUE, IField.REFBY_KEY, IField.REFBY_KEYRESULT

Parameters:
refBy -

clone

IMethod.IArgument clone()

getComment

java.lang.String getComment()
Returns the comment (or plain-english description) associated with this argument.

Returns:
String - the comment

getContainingArtifact

IAbstractArtifact getContainingArtifact()
Returns the IArtifact that is the "container" for the Method.

Returns:
the containing artifact.

getContainingIMethod

IMethod getContainingIMethod()
Returns the IMethod that is the "container" for the argument.

Returns:
the containing method.

getDefaultValue

java.lang.String getDefaultValue()
returns the default value for this argument if it is defined, null otherwise.

Returns:

getIType

IType getIType()
Returns the type of this argument.

Returns:
IType - the type of this argument

getName

java.lang.String getName()
Returns the name associated with this argument.

Returns:
String - the name of the argument

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

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

isOrdered

boolean isOrdered()

isUnique

boolean isUnique()