arlut.csd.ganymede
Interface invid_field

All Superinterfaces:

db_field, java.rmi.Remote

All Known Implementing Classes:

InvidDBField

public interface invid_field

extends db_field

Client-side remote interface for the server-side InvidDBField class.

Method Summary

QueryResult	choices()
java.lang.Object	choicesKey() This method returns a key that can be used by the client to cache the value returned by choices().
ReturnVal	createNewEmbedded() This method is used to create a new embedded object in an invid field that contains a vector of edit-in-place/embedded objects.
QueryResult	encodedValues()
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.
short	getTargetBase() Return the object type that this invid field is constrained to point to, if set
boolean	limited()
boolean	mustChoose() Returns true if the only valid values for this invid field are in the QueryResult returned by choices().

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

limited

public boolean limited()
                throws java.rmi.RemoteException

encodedValues

public QueryResult encodedValues()
                          throws java.rmi.RemoteException

mustChoose

public boolean mustChoose()
                   throws java.rmi.RemoteException

Returns true if the only valid values for this invid field are in the QueryResult returned by choices(). In particular, if mustChoose() returns true, is not an acceptable choice for this field after the field's value is initially set.

choices

public QueryResult choices()
                    throws java.rmi.RemoteException

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.

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.

createNewEmbedded

public ReturnVal createNewEmbedded()
                            throws java.rmi.RemoteException

This method is used to create a new embedded object in an invid field that contains a vector of edit-in-place/embedded objects. The ReturnVal returned indicates success/failure, and on success will provide the Invid of the newly created embedded when ReturnVal.getInvid() is called on it.

getTargetBase

public short getTargetBase()
                    throws java.rmi.RemoteException

Return the object type that this invid field is constrained to point to, if set

A negative value means there is no one type of object that this field is constrained to point to.

-1 means there is no restriction on target type.

-2 means there is no restriction on target type, but there is a specified symmetric field.