Package net.sf.okapi.common

Interface IParameterDescriptor

All Known Implementing Classes:

AbstractPart, CheckboxPart, CheckListPart, CodeFinderPart, FolderInputPart, ListSelectionPart, ParameterDescriptor, PathInputPart, SeparatorPart, SpinInputPart, TextInputPart, TextLabelPart

public interface IParameterDescriptor

Provides the different information common to all types of parameters used to configure steps, filters, and other okapi components.

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Gets the localizable name of this parameter.
String	getName()	Gets the programming name of this parameter.
Object	getParent()	Gets the object where this parameter is instantiated.
Method	getReadMethod()	Gets the method to obtain the current value of this parameter.
String	getShortDescription()	Gets the short localizable description of this parameter.
Type	getType()	Gets the type of this parameter.
Method	getWriteMethod()	Gets the method to set a new value for this this parameter.
void	setDisplayName(String displayName)	Sets the localizable name of this parameter.
void	setShortDescription(String shortDescription)	Gets the short localizable description of this parameter.

Method Detail

getName

String getName()

Gets the programming name of this parameter. the name must follow the JavaBean naming conventions. For example, a parameter accessible by getMyText and setMyText must be named myText

Returns:

the programming name of this parameter.

getDisplayName

String getDisplayName()

Gets the localizable name of this parameter.

Returns:

the localizable name of this parameter.

setDisplayName

void setDisplayName(String displayName)

Sets the localizable name of this parameter.

Parameters:

displayName - the new localizable name of this parameter.

getShortDescription

String getShortDescription()

Gets the short localizable description of this parameter.

Returns:

the short localizable description of this parameter.

setShortDescription

void setShortDescription(String shortDescription)

Gets the short localizable description of this parameter.

Parameters:

shortDescription - the new short localizable description of this parameter.

getType

Type getType()

Gets the type of this parameter.

Returns:

the type of this parameter.

getReadMethod

Method getReadMethod()

Gets the method to obtain the current value of this parameter.

Returns:

the method to get the current value of this parameter.

getWriteMethod

Method getWriteMethod()

Gets the method to set a new value for this this parameter.

Returns:

the method to set a new value of this parameter.

getParent

Object getParent()

Gets the object where this parameter is instantiated.

Returns:

the object where this parameter is instantiated.