arlut.csd.ganymede
Interface string_field

All Superinterfaces:

db_field, java.rmi.Remote

All Known Implementing Classes:

StringDBField

public interface string_field

extends db_field

Method Summary

boolean	allowed(char c)
java.lang.String	allowedChars()
boolean	canChoose()
QueryResult	choices() Returns a QueryResult encoding a list of valid string choices for this field.
java.lang.Object	choicesKey() This method returns a key that can be used by the client to cache the value returned by choices().
java.lang.String	disallowedChars()
boolean	excludeSelected(db_field x) This method returns true if this invid field should not show any choices that are currently selected in field x, where x is another field in this db_object.
int	maxSize()
int	minSize()
boolean	mustChoose()
boolean	showEcho()

Methods inherited from interface arlut.csd.ganymede.db_field

addElement, addElements, containsElement, deleteAllElements, deleteElement, deleteElement, deleteElements, getComment, getElement, getEncodingString, getFieldInfo, getFieldTemplate, getID, getName, getType, getTypeDesc, getValue, getValues, getValueString, isBuiltIn, isDefined, isEditable, isEditInPlace, isVector, isVisible, setElement, setValue, size

Method Detail

maxSize

public int maxSize()
            throws java.rmi.RemoteException

minSize

public int minSize()
            throws java.rmi.RemoteException

showEcho

public boolean showEcho()
                 throws java.rmi.RemoteException

canChoose

public boolean canChoose()
                  throws java.rmi.RemoteException

mustChoose

public boolean mustChoose()
                   throws java.rmi.RemoteException

allowedChars

public java.lang.String allowedChars()
                              throws java.rmi.RemoteException

disallowedChars

public java.lang.String disallowedChars()
                                 throws java.rmi.RemoteException

allowed

public boolean allowed(char c)
                throws java.rmi.RemoteException

excludeSelected

public boolean excludeSelected(db_field x)
                        throws java.rmi.RemoteException

This method returns true if this invid field should not show any choices that are currently selected in field x, where x is another field in this db_object.

choices

public QueryResult choices()
                    throws java.rmi.RemoteException

Returns a QueryResult encoding a list of valid string choices for this field. Consult canChoose() and mustChoose() to determine how the results of this method should be treated.

choicesKey

public java.lang.Object choicesKey()
                            throws java.rmi.RemoteException

This method returns a key that can be used by the client to cache the value returned by choices(). If the client already has the key cached on the client side, it can provide the choice list from its cache rather than calling choices() on this object again.