com.sssw.cm.api
Interface EbiDocumentXmlDataOptions

All Superinterfaces:

EbiDirEntryXmlDataOptions, EbiXmlDataOptions

public interface EbiDocumentXmlDataOptions

extends EbiDirEntryXmlDataOptions

Objects that implement this interface describe options for transferring data to/from XML for documents.

See Also:

EbiDocument

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

DEFAULT_DATE_PATTERN, DEFAULT_TIME_PATTERN, DEFAULT_TIMESTAMP_PATTERN

Method Summary

boolean	mustCheckOut() Tells whether documents must be checked out as they're processed
boolean	mustIncludeAllParts() Tells whether all document parts must be included.
boolean	mustIncludeCategoryRefs() Tells whether document category references must be included.
boolean	mustIncludeContent() Tells whether document content must be included.
boolean	mustIncludeContentVersions() Tells whether content versions must be included.
boolean	mustIncludeExtensionMetadata() Tells whether document extension metadata must be included.
boolean	mustIncludeLayoutSet() Tells whether layout set information must be included
boolean	mustIncludeMetadata() Tells whether document metadata must be included.
boolean	mustIncludeSecurityInfo() Tells whether document security information must be included
void	setCheckOut(boolean checkOut) Sets the "check out documents" option
void	setIncludeAllParts(boolean include) Sets the "include all document parts" option.
void	setIncludeCategoryRefs(boolean include) Sets the "include document category references" option.
void	setIncludeContent(boolean include) Sets the "include document content" option.
void	setIncludeContentVersions(boolean include) Sets the "include content versions" option.
void	setIncludeExtensionMetadata(boolean include) Sets the "include extension metadata" option.
void	setIncludeLayoutSet(boolean include) Sets the "include layout set" option.
void	setIncludeMetadata(boolean include) Sets the "include document metadata" option.
void	setIncludeSecurityInfo(boolean include) Sets the "include security information" option.

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

mustCreateNonexistentDirectories, mustIgnoreParentDirectory, mustIncludeDescendants, setCreateNonexistentDirectories, setIgnoreParentDirectory, setIncludeDescendants

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

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

Method Detail

setIncludeAllParts

public void setIncludeAllParts(boolean include)

Sets the "include all document parts" option.

Parameters:

include - if true, all document parts are included

mustIncludeAllParts

public boolean mustIncludeAllParts()

Tells whether all document parts must be included.

Returns:

true if all document parts must be included

setIncludeMetadata

public void setIncludeMetadata(boolean include)

Sets the "include document metadata" option.

Parameters:

include - if true, document metadata is included

mustIncludeMetadata

public boolean mustIncludeMetadata()

Tells whether document metadata must be included.

Returns:

true if document metadata must be included

setIncludeExtensionMetadata

public void setIncludeExtensionMetadata(boolean include)

Sets the "include extension metadata" option.

Parameters:

include - if true, document extension metadata must be included

mustIncludeExtensionMetadata

public boolean mustIncludeExtensionMetadata()

Tells whether document extension metadata must be included.

Returns:

true if document extension metadata must be included

setIncludeContent

public void setIncludeContent(boolean include)

Sets the "include document content" option.

Parameters:

include - if true, document content must be included

mustIncludeContent

public boolean mustIncludeContent()

Tells whether document content must be included.

Returns:

true if the document content must be included

setIncludeContentVersions

public void setIncludeContentVersions(boolean include)

Sets the "include content versions" option.

Parameters:

include - if true, content versions must be included

mustIncludeContentVersions

public boolean mustIncludeContentVersions()

Tells whether content versions must be included.

Returns:

true if content versions must be included

setIncludeSecurityInfo

public void setIncludeSecurityInfo(boolean include)

Sets the "include security information" option.

Specified by:

setIncludeSecurityInfo in interface EbiXmlDataOptions

Parameters:

include - if true, security information must be included

mustIncludeSecurityInfo

public boolean mustIncludeSecurityInfo()

Tells whether document security information must be included

Specified by:

mustIncludeSecurityInfo in interface EbiXmlDataOptions

Returns:

true if document security information must be included

setIncludeLayoutSet

public void setIncludeLayoutSet(boolean include)

Sets the "include layout set" option.

Parameters:

include - if true, layout set information is included

mustIncludeLayoutSet

public boolean mustIncludeLayoutSet()

Tells whether layout set information must be included

Returns:

true if layout set information must be included

setIncludeCategoryRefs

public void setIncludeCategoryRefs(boolean include)

Sets the "include document category references" option.

Parameters:

include - if true, document category references must be included

mustIncludeCategoryRefs

public boolean mustIncludeCategoryRefs()

Tells whether document category references must be included.

Returns:

true if document category references must be included

setCheckOut

public void setCheckOut(boolean checkOut)

Sets the "check out documents" option

Parameters:

checkOut - if true, documents are checked out as they're processed

mustCheckOut

public boolean mustCheckOut()

Tells whether documents must be checked out as they're processed

Returns:

true if documents must be checked out as they're processed