com.sssw.cm.api
Interface EbiDirEntryXmlDataOptions

All Superinterfaces:

EbiXmlDataOptions

All Known Subinterfaces:

EbiDocumentXmlDataOptions

public interface EbiDirEntryXmlDataOptions

extends EbiXmlDataOptions

Objects that implement this interface describe options for transferring data to/from XML for elements that are directory entries.

See Also:

EbiDirectoryEntry

Fields inherited from interface com.sssw.cm.api.EbiXmlDataOptions

DEFAULT_DATE_PATTERN, DEFAULT_TIME_PATTERN, DEFAULT_TIMESTAMP_PATTERN

Method Summary

boolean	mustCreateNonexistentDirectories(String dirElType) Tells whether nonexistent directories of the specified type must be created as the XML for the element is being processed
boolean	mustIgnoreParentDirectory() Tells whether the parent directory must be ignored when initializing the directory entry object from XML data.
boolean	mustIncludeDescendants() Tells whether descendant elements are to be included into the XML of the element
void	setCreateNonexistentDirectories(String dirElType, boolean create) Sets the "create nonexistent directories" option for a specific type of directory
void	setIgnoreParentDirectory(boolean ignore) Sets the option to ignore the parent directory when initializing the directory entry object from XML data.
void	setIncludeDescendants(boolean include) Sets the "include descendants" option.

Methods implemented from interface com.sssw.cm.api.EbiXmlDataOptions

clear, fromXML, getDatePattern, getLocale, getTimePattern, getTimestampPattern, getTimeZone, mustIncludeOptions, mustIncludeSecurityInfo, mustUseUUIDs, setDatePattern, setIncludeOptions, setIncludeSecurityInfo, setLocale, setTimePattern, setTimestampPattern, setTimeZone, setUseUUIDs, stringToTimestamp, timestampToString, toXML

Method Detail

setIncludeDescendants

public void setIncludeDescendants(boolean include)

Sets the "include descendants" option.

Parameters:

include - if true, descendant elements are included into the XML of the element

mustIncludeDescendants

public boolean mustIncludeDescendants()

Tells whether descendant elements are to be included into the XML of the element

Returns:

true if descendant elements are to be included

setCreateNonexistentDirectories

public void setCreateNonexistentDirectories(String dirElType,
                                            boolean create)

Sets the "create nonexistent directories" option for a specific type of directory

Parameters:

dirElType - the directory element type, e.g. EbiDocFolder.EL_DOC_FOLDER or EbiDocCategory.EL_DOC_CATEGORY

create - if true, nonexistent directories of the specified type will be created as the element XML is processed

mustCreateNonexistentDirectories

public boolean mustCreateNonexistentDirectories(String dirElType)

Tells whether nonexistent directories of the specified type must be created as the XML for the element is being processed

Parameters:

dirElType - the directory element type, e.g. EbiDocFolder.EL_DOC_FOLDER or EbiDocCategory.EL_DOC_CATEGORY

Returns:

true if nonexistent directories of the specified type must be created as the XML for the element is being processed

setIgnoreParentDirectory

public void setIgnoreParentDirectory(boolean ignore)

Sets the option to ignore the parent directory when initializing the directory entry object from XML data. The default is false, "do not ignore the parent directory".

Parameters:

ignore - if true, ignore the parent directory

mustIgnoreParentDirectory

public boolean mustIgnoreParentDirectory()

Tells whether the parent directory must be ignored when initializing the directory entry object from XML data.

Returns:

true if the parent directory must be ignored, false otherwise