com.mindoo.remote.api.symphony.document
Interface IRemoteDateTimeField

All Superinterfaces:

IRemoteField

public interface IRemoteDateTimeField
extends IRemoteField

This class is a subclass of the Field class and represents a date or time field in a document.

Creation and access

• To get a date time field in a document, use the itemByType method in the Fields class.
• To create a date time field, use the addDateField method or Example: addTimeField method in the Fields class.

Field Summary

static int	DISPLAY_DATE specifies that only the date displays.
static int	DISPLAY_TIME specifies that only the time displays.

Method Summary

int	getDisplayMode() This property returns or sets the display mode of the date or time field.
java.util.Date	getValue() This property returns or sets the value of the date or time field.
boolean	isFixed() This property returns or sets whether the value of the field can be changed.
void	setDisplayMode(int displayMode) This property returns or sets the display mode of the date or time field.
void	setFixed(boolean fixed) This property returns or sets whether the value of the field can be changed.
void	setValue(java.util.Date date) This property returns or sets the value of the date or time field.

Methods inherited from interface com.mindoo.remote.api.symphony.document.IRemoteField

getContent, getRange, getType, remove

Field Detail

DISPLAY_TIME

static final int DISPLAY_TIME

specifies that only the time displays.

See Also:

Constant Field Values

DISPLAY_DATE

static final int DISPLAY_DATE

specifies that only the date displays.

See Also:

Constant Field Values

Method Detail

setDisplayMode

void setDisplayMode(int displayMode)
                    throws RemoteEclipseAPIException

This property returns or sets the display mode of the date or time field.

Legal values:

Constant	Value	Description
DateTimeField.DISPLAY_TIME	0	specifies that only the time displays.
DateTimeField.DISPLAY_DATE	1	specifies that only the date displays.

Parameters:

displayMode -

Throws:

RemoteEclipseAPIException

getDisplayMode

int getDisplayMode()
                   throws RemoteEclipseAPIException

This property returns or sets the display mode of the date or time field.

Returns:

mode

Throws:

RemoteEclipseAPIException

setValue

void setValue(java.util.Date date)
              throws RemoteEclipseAPIException

This property returns or sets the value of the date or time field. If this property's value is changed, the Fixed property is set to true.

Parameters:

date -

Throws:

RemoteEclipseAPIException

getValue

java.util.Date getValue()
                        throws RemoteEclipseAPIException

This property returns or sets the value of the date or time field. If this property's value is changed, the Fixed property is set to true.

Returns:

date

Throws:

RemoteEclipseAPIException

isFixed

boolean isFixed()
                throws RemoteEclipseAPIException

This property returns or sets whether the value of the field can be changed.

Returns:

true, when the value of the field does not refresh with the System's time.

Throws:

RemoteEclipseAPIException

setFixed

void setFixed(boolean fixed)
              throws RemoteEclipseAPIException

This property returns or sets whether the value of the field can be changed.

Parameters:

fixed - true, when the value of the field does not refresh with the System's time.

Throws:

RemoteEclipseAPIException