com.ibm.workplace.wcm.api
Interface DateComponent

All Superinterfaces:

ContentComponent

public interface DateComponent

extends ContentComponent

Represents a Date component.

A DateComponent is a ContentComponent and cannot be stored as a separate entity in the repository.

A DateComponent can contain Date. This interface provides methods to retrieve and set the Date contained within this component.

note: since v6.0.0, a ContentComponent is referred to as an "Element" in the Authoring UI.

See Also:

ContentComponent

Field Summary

static int	TYPE_DATE Type constant indicating that the Date returned from this DateComponent will be formatted to only show the date.
static int	TYPE_TIME Type constant indicating that the Date returned from this DateComponent will be formatted to only show the time.
static int	TYPE_TIME_AND_DATE Type constant indicating that the Date returned from this DateComponent will be formatted to show the time and date.

Method Summary

java.util.Date	getDate() Returns the Date contained in this component as a Date.
int	getDateType() Returns the formatting type set in this DateComponent.
void	setDate(java.util.Date date) Sets the Date contained in this DateComponent.
void	setDateType(int dateType) Sets the formatting type for this DateComponent.

Methods inherited from interface com.ibm.workplace.wcm.api.ContentComponent

getContainer, getName

Field Detail

TYPE_TIME_AND_DATE

public static final int TYPE_TIME_AND_DATE

Type constant indicating that the Date returned from this DateComponent will be formatted to show the time and date.

See Also:

Constant Field Values

TYPE_DATE

public static final int TYPE_DATE

Type constant indicating that the Date returned from this DateComponent will be formatted to only show the date.

See Also:

Constant Field Values

TYPE_TIME

public static final int TYPE_TIME

Type constant indicating that the Date returned from this DateComponent will be formatted to only show the time.

See Also:

Constant Field Values

Method Detail

getDate

public java.util.Date getDate()

Returns the Date contained in this component as a Date.

Returns null if the Date is not set.

Returns:

the Date

setDate

public void setDate(java.util.Date date)
             throws OperationFailedException

Sets the Date contained in this DateComponent.

Note. This method replaces any existing Date in this component.

Parameters:

date - the Date

Throws:

OperationFailedException - if the string argument is null or the Date could not be set

getDateType

public int getDateType()

Returns the formatting type set in this DateComponent.

Returns the default value DateComponent.TYPE_TIME if the new date has been set.

Returns:

the date formatting type

setDateType

public void setDateType(int dateType)
                 throws OperationFailedException

Sets the formatting type for this DateComponent.

Valid values are:

• TYPE_TIME - Date format type to show the time
• TYPE_DATE - Date format type to show the date
• TYPE_TIME_AND_DATE - Date format type to show the date and time

Parameters:

dateType - the date formatting type to be set

Throws:

OperationFailedException - if an invalid date formatting type was passed in