com.stellent.cis.client.command
Interface ICommandField

All Superinterfaces:

java.io.Serializable

public interface ICommandField
extends java.io.Serializable

Used in conjunction with the ICommandDescriptor interface. Describes an individual field of a ICommand.

Method Summary

java.lang.Class	getClassType()
java.lang.String	getDescription()
java.lang.String	getFriendlyName()
java.lang.String	getName()
java.lang.String	getType()
java.lang.Object	getValue()
java.lang.Object[]	getValueList()
boolean	isMultiValued()
boolean	isRequired()

Method Detail

getName

java.lang.String getName()

Returns:

the name of the field

getValue

java.lang.Object getValue()

Returns:

the value of this field

getDescription

java.lang.String getDescription()

Returns:

a description of the field

getFriendlyName

java.lang.String getFriendlyName()

Returns:

a friendly version of the name

isRequired

boolean isRequired()

Returns:

true if required, false otherwise

getType

java.lang.String getType()

Returns:

a String describing the type of field

isMultiValued

boolean isMultiValued()

Returns:

true if this field can have multiple values

getValueList

java.lang.Object[] getValueList()

Returns:

a list of acceptable values for this field. If the list is empty, this field value is not restricted

getClassType

java.lang.Class getClassType()

Returns:

the classname of the type