arlut.csd.ganymede.rmi

Interface field_option_field

All Superinterfaces:

db_field, java.rmi.Remote

All Known Implementing Classes:

FieldOptionDBField

public interface field_option_field
extends db_field

Client-side remote interface to the FieldOptionDBField class.

Method Summary

Methods

Modifier and Type	Method and Description
FieldOptionMatrix	getMatrix() Return a serializable, read-only copy of this field's option matrix
SyncPrefEnum	getOption(Base base) Returns a SyncPrefEnum object representing this field option field's option on the base <base>
SyncPrefEnum	getOption(Base base, BaseField field) Returns a SyncPrefEnum representing this field option field's option on the field <field> in base <base>
SyncPrefEnum	getOption(short baseID) Returns a SyncPrefEnum representing this field option field's option on the base <base>
SyncPrefEnum	getOption(short baseID, short fieldID) Returns a SyncPrefEnum representing this field option field's option on the field <field> in base <base>
ReturnVal	resetOptions() Resets the options in this FieldOptionDBField to the empty set.
ReturnVal	setOption(Base base, BaseField field, SyncPrefEnum option) Sets the SyncPrefEnum for this matrix for base <baseID>, field <fieldID> to <option>.
ReturnVal	setOption(Base base, SyncPrefEnum option) Sets the SyncPrefEnum for this matrix for base <baseID> to <option> This operation will fail if this field option field is not associated with a currently checked-out-for-editing FieldOptionDBField.
ReturnVal	setOption(short baseID, short fieldID, SyncPrefEnum option) Sets the SyncPrefEnum for this matrix for base <baseID>, field <fieldID> to <option>.
ReturnVal	setOption(short baseID, SyncPrefEnum option) Sets the SyncPrefEnum for this matrix for base <baseID> to <option> This operation will fail if this field option field is not associated with a currently checked-out-for-editing FieldOptionDBField.

Methods inherited from interface arlut.csd.ganymede.rmi.db_field

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

Method Detail

getMatrix

FieldOptionMatrix getMatrix()
                            throws java.rmi.RemoteException

Return a serializable, read-only copy of this field's option matrix

Throws:

java.rmi.RemoteException

getOption

SyncPrefEnum getOption(short baseID,
                     short fieldID)
                       throws java.rmi.RemoteException

Returns a SyncPrefEnum representing this field option field's option on the field <field> in base <base>

Throws:

java.rmi.RemoteException

getOption

SyncPrefEnum getOption(short baseID)
                       throws java.rmi.RemoteException

Returns a SyncPrefEnum representing this field option field's option on the base <base>

Throws:

java.rmi.RemoteException

getOption

SyncPrefEnum getOption(Base base,
                     BaseField field)
                       throws java.rmi.RemoteException

Returns a SyncPrefEnum representing this field option field's option on the field <field> in base <base>

Throws:

java.rmi.RemoteException

getOption

SyncPrefEnum getOption(Base base)
                       throws java.rmi.RemoteException

Returns a SyncPrefEnum object representing this field option field's option on the base <base>

Throws:

java.rmi.RemoteException

resetOptions

ReturnVal resetOptions()
                       throws java.rmi.RemoteException

Resets the options in this FieldOptionDBField to the empty set. Used by non-interactive clients to reset the SyncPrefEnum values to a known state before setting options.

Returns null on success, or a failure-coded ReturnVal on permissions failure.

Throws:

java.rmi.RemoteException

setOption

ReturnVal setOption(short baseID,
                  short fieldID,
                  SyncPrefEnum option)
                    throws java.rmi.RemoteException

Sets the SyncPrefEnum for this matrix for base <baseID>, field <fieldID> to <option>.

This operation will fail if this field option field is not associated with a currently checked-out-for-editing FieldOptionDBField.

Throws:

java.rmi.RemoteException

setOption

ReturnVal setOption(short baseID,
                  SyncPrefEnum option)
                    throws java.rmi.RemoteException

Sets the SyncPrefEnum for this matrix for base <baseID> to <option>

This operation will fail if this field option field is not associated with a currently checked-out-for-editing FieldOptionDBField.

Throws:

java.rmi.RemoteException

setOption

ReturnVal setOption(Base base,
                  BaseField field,
                  SyncPrefEnum option)
                    throws java.rmi.RemoteException

Sets the SyncPrefEnum for this matrix for base <baseID>, field <fieldID> to <option>.

This operation will fail if this field option field is not associated with a currently checked-out-for-editing FieldOptionDBField.

Throws:

java.rmi.RemoteException

setOption

ReturnVal setOption(Base base,
                  SyncPrefEnum option)
                    throws java.rmi.RemoteException

Sets the SyncPrefEnum for this matrix for base <baseID> to <option>

This operation will fail if this field option field is not associated with a currently checked-out-for-editing FieldOptionDBField.

Throws:

java.rmi.RemoteException