com.sssw.cm.api
Interface EbiXmlDataOptions

All Known Subinterfaces:

EbiDirEntryXmlDataOptions, EbiDocumentXmlDataOptions

public interface EbiXmlDataOptions

Objects that implement this interface define options for serializing CM element data to XML and deserializing data from XML.

Field Summary

static String	DEFAULT_DATE_PATTERN The default date pattern ("MM/dd/yyyy").
static String	DEFAULT_TIME_PATTERN The default time pattern ("HH:mm:ss").
static String	DEFAULT_TIMESTAMP_PATTERN The default timestamp pattern ("MM/dd/yyyy HH:mm:ss").

Method Summary

void	clear() Clears the current state of this options object.
void	fromXML(Node xml) Populate the options object from XML.
String	getDatePattern(boolean getDefaultIfNotSet) Gets the date pattern to use.
Locale	getLocale(boolean getDefaultIfNotSet) Gets the Locale to use.
String	getTimePattern(boolean getDefaultIfNotSet) Gets the time pattern to use.
String	getTimestampPattern(boolean getDefaultIfNotSet) Gets the timestamp pattern to use.
TimeZone	getTimeZone(boolean getDefaultIfNotSet) Gets the time zone to use.
boolean	mustIncludeOptions() Tells whether to include the summary of XML data handling options into the XML that represents a CM element.
boolean	mustIncludeSecurityInfo() Tells whether security information for a given CM element must be included into its XML
boolean	mustUseUUIDs() Tells whether element UUID's are to be used or not
void	setDatePattern(String datePattern) Sets the the date pattern to use.
void	setIncludeOptions(boolean include) Sets the option to include the summary of XML data handling options into the XML that represents a CM element.
void	setIncludeSecurityInfo(boolean include) Sets the option for whether to include security information for a given CM element into its XML.
void	setLocale(Locale locale) Sets the Locale to use.
void	setTimePattern(String timePattern) Sets the timestamp pattern to use.
void	setTimestampPattern(String timestampPattern) Sets the timestamp pattern to use.
void	setTimeZone(TimeZone timeZone) Sets the time zone to use.
void	setUseUUIDs(boolean useUUIDs) Sets the option to use the element UUID's or not.
Timestamp	stringToTimestamp(String strValue) Converts the specified String value into a Timestamp value, based on the options specified in this object.
String	timestampToString(Timestamp tsValue) Converts the specified Timestamp value into a String value, based on the options specified in this object.
Document	toXML() Gets the XML representation of this options object.

Field Detail

DEFAULT_TIME_PATTERN

public static final String DEFAULT_TIME_PATTERN

The default time pattern ("HH:mm:ss").

DEFAULT_DATE_PATTERN

public static final String DEFAULT_DATE_PATTERN

The default date pattern ("MM/dd/yyyy").

DEFAULT_TIMESTAMP_PATTERN

public static final String DEFAULT_TIMESTAMP_PATTERN

The default timestamp pattern ("MM/dd/yyyy HH:mm:ss").

Method Detail

getLocale

public Locale getLocale(boolean getDefaultIfNotSet)

Gets the Locale to use.

Parameters:

getDefaultIfNotSet - if true and no locale was set in the options, get the default Locale of the host machine.

Returns:

the Locale to use

setLocale

public void setLocale(Locale locale)

Sets the Locale to use.

Parameters:

locale - the Locale to use

getTimePattern

public String getTimePattern(boolean getDefaultIfNotSet)

Gets the time pattern to use.

Parameters:

getDefaultIfNotSet - if true and no time pattern was set in the options, get the default time pattern

Returns:

the time pattern to use

getDatePattern

public String getDatePattern(boolean getDefaultIfNotSet)

Gets the date pattern to use.

Parameters:

getDefaultIfNotSet - if true and no date pattern was set in the options, get the default date pattern

Returns:

the date pattern to use

getTimestampPattern

public String getTimestampPattern(boolean getDefaultIfNotSet)

Gets the timestamp pattern to use.

Parameters:

getDefaultIfNotSet - if true and no timestamp pattern was set in the options, get the default timestamp pattern

Returns:

the timestamp pattern to use

setTimePattern

public void setTimePattern(String timePattern)

Sets the timestamp pattern to use.

Parameters:

timePattern - the time pattern to use

setDatePattern

public void setDatePattern(String datePattern)

Sets the the date pattern to use.

Parameters:

datePattern - the date pattern to use

setTimestampPattern

public void setTimestampPattern(String timestampPattern)

Sets the timestamp pattern to use.

Parameters:

timestampPattern - the timestamp pattern to use

getTimeZone

public TimeZone getTimeZone(boolean getDefaultIfNotSet)

Gets the time zone to use.

Parameters:

getDefaultIfNotSet - if true and no time zone was set in to the options, return the default time zone (that of the host machine)

Returns:

the time zone to use

setTimeZone

public void setTimeZone(TimeZone timeZone)

Sets the time zone to use.

Parameters:

timeZone - the time zone to use

setUseUUIDs

public void setUseUUIDs(boolean useUUIDs)

Sets the option to use the element UUID's or not.

Parameters:

useUUIDs - if true, element UUID's are to be used, otherwise only elements' names/URL's to uniquely identify the elements; the default is false ("do not use the element UUID's")

mustUseUUIDs

public boolean mustUseUUIDs()

Tells whether element UUID's are to be used or not

Returns:

true if element UUID's are to be used, false otherwise

setIncludeOptions

public void setIncludeOptions(boolean include)

Sets the option to include the summary of XML data handling options into the XML that represents a CM element.

Parameters:

include - if true, include the options summary into the XML

mustIncludeOptions

public boolean mustIncludeOptions()

Tells whether to include the summary of XML data handling options into the XML that represents a CM element.

Returns:

true if the options summary must be included into the XML

setIncludeSecurityInfo

public void setIncludeSecurityInfo(boolean include)

Sets the option for whether to include security information for a given CM element into its XML.

Parameters:

include - if true, include security information for the given CM element into its XML

mustIncludeSecurityInfo

public boolean mustIncludeSecurityInfo()

Tells whether security information for a given CM element must be included into its XML

Returns:

true if security information for the given CM element must be included into its XML

fromXML

public void fromXML(Node xml)

Populate the options object from XML.

Parameters:

xml - XML summary of the options

toXML

public Document toXML()

Gets the XML representation of this options object.

Returns:

the XML representation of this options object

clear

public void clear()

Clears the current state of this options object.

stringToTimestamp

public Timestamp stringToTimestamp(String strValue)

Converts the specified String value into a Timestamp value, based on the options specified in this object.

Parameters:

strValue - the String value to convert

Returns:

the Timestamp value

timestampToString

public String timestampToString(Timestamp tsValue)

Converts the specified Timestamp value into a String value, based on the options specified in this object.

Parameters:

tsValue - the Timestamp value

Returns:

the String value