net.sf.mmapps.modules.config
Interface FieldConfiguration

All Known Implementing Classes:

BasicFieldConfiguration

public interface FieldConfiguration

very simple java interface representing the configuration of a field

Version:

$Id: FieldConfiguration.java,v 1.2 2004/05/18 13:53:55 keesj Exp $

Author:

Kees Jongenburger

Method Summary

java.lang.String	getDescription(java.lang.String lang)
java.util.Properties	getDescriptions()
java.lang.String	getDocType()
java.lang.String	getEditorPosition()
java.lang.String	getGUIName(java.lang.String lang)
java.util.Properties	getGUINames()
java.lang.String	getGUIType() some applications need to know how to display the field this method returns a "hint" on how to display the field
java.lang.String	getListPosition()
java.lang.String	getName()
java.lang.String	getSearchPosition()
java.lang.String	getSize() if applicable this methods returns the size of the field
java.lang.String	getState()
java.lang.String	getType()
boolean	isKey()
boolean	isNotNull()
void	setDescription(java.lang.String lang, java.lang.String value)
void	setDocType(java.lang.String doctype)
void	setEditorPosition(java.lang.String pos)
void	setGUIName(java.lang.String lang, java.lang.String value)
void	setGUIType(java.lang.String guitype)
void	setIsKey(boolean iskey)
void	setIsNotNull(boolean isNotNull)
void	setListPosition(java.lang.String pos)
void	setName(java.lang.String name)
void	setSearchPosition(java.lang.String pos)
void	setSize(java.lang.String size)
void	setState(java.lang.String state)
void	setType(java.lang.String type)

Method Detail

getGUIName

public java.lang.String getGUIName(java.lang.String lang)

Returns:

a human readable fieldname

setGUIName

public void setGUIName(java.lang.String lang,
                       java.lang.String value)

getGUINames

public java.util.Properties getGUINames()

getName

public java.lang.String getName()

Returns:

the name of the field

setName

public void setName(java.lang.String name)

getDescriptions

public java.util.Properties getDescriptions()

Returns:

the descriptions of the fields

getDescription

public java.lang.String getDescription(java.lang.String lang)

Returns:

the description of the fields in a certain language

setDescription

public void setDescription(java.lang.String lang,
                           java.lang.String value)

getType

public java.lang.String getType()

Returns:

the mmbase-type of the field

setType

public void setType(java.lang.String type)

getState

public java.lang.String getState()

Returns:

the mmbase-state of the field

setState

public void setState(java.lang.String state)

isKey

public boolean isKey()

Returns:

the if the field is a key

setIsKey

public void setIsKey(boolean iskey)

isNotNull

public boolean isNotNull()

Returns:

the if the field may be null

setIsNotNull

public void setIsNotNull(boolean isNotNull)

getDocType

public java.lang.String getDocType()

Returns:

the doctype of the field (only for xml types)

setDocType

public void setDocType(java.lang.String doctype)

getSize

public java.lang.String getSize()

if applicable this methods returns the size of the field

Returns:

the size of the field

setSize

public void setSize(java.lang.String size)

getGUIType

public java.lang.String getGUIType()

some applications need to know how to display the field this method returns a "hint" on how to display the field

Returns:

a "hint" on howto display a field

setGUIType

public void setGUIType(java.lang.String guitype)

getEditorPosition

public java.lang.String getEditorPosition()

setEditorPosition

public void setEditorPosition(java.lang.String pos)

getSearchPosition

public java.lang.String getSearchPosition()

setSearchPosition

public void setSearchPosition(java.lang.String pos)

getListPosition

public java.lang.String getListPosition()

setListPosition

public void setListPosition(java.lang.String pos)