Class ArgumentInfo
java.lang.Object
org.eclipse.birt.report.model.api.metadata.ArgumentInfo
- All Implemented Interfaces:
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 -
Method Summary
Modifier and TypeMethodDescriptionReturns the class type of this argument.Returns the display name for the property if the resource key of display name is defined.Returns the resource key for the display name.getName()
Returns the internal name for the argument.getType()
Returns the script type of this argument.protected void
Sets the message ID for the display name.protected void
Sets the internal name of the property.protected void
Sets the script type of this argument.toString()
-
Constructor Details
-
ArgumentInfo
public ArgumentInfo()
-
-
Method Details
-
getName
Description copied from interface:IArgumentInfo
Returns the internal name for the argument.- Specified by:
getName
in interfaceIArgumentInfo
- Returns:
- the internal (non-localized) name for the argument
-
getDisplayName
Returns the display name for the property if the resource key of display name is defined. Otherwise, return empty string.- Specified by:
getDisplayName
in interfaceIArgumentInfo
- Returns:
- the user-visible, localized display name for the property
-
setName
Sets the internal name of the property.- Parameters:
theName
- the internal property name
-
getDisplayNameKey
Returns the resource key for the display name.- Specified by:
getDisplayNameKey
in interfaceIArgumentInfo
- Returns:
- The display name message ID.
-
setDisplayNameKey
Sets the message ID for the display name.- Parameters:
id
- message ID for the display name
-
getType
Returns the script type of this argument.- Specified by:
getType
in interfaceIArgumentInfo
- Returns:
- the script type to set
-
getClassType
Returns the class type of this argument.- Specified by:
getClassType
in interfaceIArgumentInfo
- Returns:
- the class type to set
-
setType
Sets the script type of this argument.- Parameters:
type
- the script type to set
-
toString
-