Class ArgumentInfo
- java.lang.Object
-
- org.eclipse.birt.report.model.api.metadata.ArgumentInfo
-
- All Implemented Interfaces:
IArgumentInfo
public class ArgumentInfo extends java.lang.Object implements IArgumentInfo
Represents the definition of argument. The argument definition includes the data type, internal name, and display name.
-
-
Field Summary
-
Fields inherited from interface org.eclipse.birt.report.model.api.metadata.IArgumentInfo
OPTIONAL_ARGUMENT_NAME
-
-
Constructor Summary
Constructors Constructor Description ArgumentInfo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IClassInfogetClassType()Returns the class type of this argument.java.lang.StringgetDisplayName()Returns the display name for the property if the resource key of display name is defined.java.lang.StringgetDisplayNameKey()Returns the resource key for the display name.java.lang.StringgetName()Returns the internal name for the argument.java.lang.StringgetType()Returns the script type of this argument.protected voidsetDisplayNameKey(java.lang.String id)Sets the message ID for the display name.protected voidsetName(java.lang.String theName)Sets the internal name of the property.protected voidsetType(java.lang.String type)Sets the script type of this argument.java.lang.StringtoString()
-
-
-
Method Detail
-
getName
public java.lang.String getName()
Description copied from interface:IArgumentInfoReturns the internal name for the argument.- Specified by:
getNamein interfaceIArgumentInfo- Returns:
- the internal (non-localized) name for the argument
-
getDisplayName
public java.lang.String getDisplayName()
Returns the display name for the property if the resource key of display name is defined. Otherwise, return empty string.- Specified by:
getDisplayNamein interfaceIArgumentInfo- Returns:
- the user-visible, localized display name for the property
-
setName
protected void setName(java.lang.String theName)
Sets the internal name of the property.- Parameters:
theName- the internal property name
-
getDisplayNameKey
public java.lang.String getDisplayNameKey()
Returns the resource key for the display name.- Specified by:
getDisplayNameKeyin interfaceIArgumentInfo- Returns:
- The display name message ID.
-
setDisplayNameKey
protected void setDisplayNameKey(java.lang.String id)
Sets the message ID for the display name.- Parameters:
id- message ID for the display name
-
getType
public java.lang.String getType()
Returns the script type of this argument.- Specified by:
getTypein interfaceIArgumentInfo- Returns:
- the script type to set
-
getClassType
public IClassInfo getClassType()
Returns the class type of this argument.- Specified by:
getClassTypein interfaceIArgumentInfo- Returns:
- the class type to set
-
setType
protected void setType(java.lang.String type)
Sets the script type of this argument.- Parameters:
type- the script type to set
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-