com.sssw.cm.api
Interface EbiImporter

All Superinterfaces:

EbiDataTransfer, EbiTool, Serializable

public interface EbiImporter

extends EbiDataTransfer

Objects that implement this interface are used for importing CM data into the Content Management System.

Since:

v.3.0

Field Summary

static String

CM_IMPORT_LOG The name of the CM Import Log.

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

ADMIN_METADATA_PATH, CATEGORIES_METADATA_PATH, CONTENTMGMT_INF_PATH, DOCS_CONTENT_PATH, DOCS_CONTENT_VERSIONS_PATH, DOCS_METADATA_PATH, DOCTYPES_DATA_PATH, DOCTYPES_METADATA_PATH, FIELDS_DATA_PATH, FIELDS_METADATA_PATH, FOLDERS_METADATA_PATH, LINKS_DATA_PATH, LINKS_METADATA_PATH, STYLES_METADATA_PATH

Method Summary

EbiElementOverwrite	getCategoriesOverwrite() Returns the category overwrite options.
EbiElementOverwrite	getDoctypesOverwrite() Returns the doctype overwrite options.
EbiElementOverwrite	getDocumentsOverwrite() Returns the document overwrite options.
EbiElementOverwrite	getFieldsOverwrite() Returns the field overwrite options
EbiElementOverwrite	getFoldersOverwrite() Returns the folder overwrite options.
EbiElementOverwrite	getLinksOverwrite() Returns the link overwrite options.
EbiElementOverwrite	getStylesOverwrite() Returns the style overwrite options.
EbiDocFolder	getTargetFolder() Returns the target folder (defaults to the Root Folder).
ZipInputStream	getZipInputStream() Returns the input zip input stream, if any was set
Collection	importDocuments(EbiContext context, InputStream inDocData) Deprecated. See EbiTool.execute(EbiContext context).
boolean	mustCheckOutDocs() Tells whether the Importer is to check out any documents it creates at execution time, to the user whose context is set into the Importer via the setContext method.
boolean	mustCreateNonexistentCategories() Tells whether the tool must create any non-existent categories.
boolean	mustCreateNonexistentFolders() Tells whether the tool must create any non-existent folders.
boolean	mustPublishDocsImmediately() Tells whether any added documents must be published immediately.
void	setCategoriesOverwrite(EbiElementOverwrite overwrite) Sets the category overwrite options.
void	setCheckOutDocs(boolean checkOut) Specifies whether to check out all the imported documents to the user whose context is passed in to the execute() method.
void	setCreateNonexistentCategories(boolean create) Sets the option to to create any categories that do not exist but whose URLs are mentioned in the input import XML such as the document XML.
void	setCreateNonexistentFolders(boolean create) Sets the option to to create any folders that do not exist but whose URLs are mentioned in the input import XML such as the document XML.
void	setDoctypesOverwrite(EbiElementOverwrite overwrite) Sets the doctype overwrite options.
void	setDocumentsOverwrite(EbiElementOverwrite overwrite) Sets the document overwrite options.
void	setFieldsOverwrite(EbiElementOverwrite overwrite) Sets the field overwrite options.
void	setFoldersOverwrite(EbiElementOverwrite overwrite) Sets the folder overwrite options.
void	setLinksOverwrite(EbiElementOverwrite overwrite) Sets the link overwrite options
void	setPublishDocsImmediately(boolean publishImmediately) Specifies whether documents should be published immediately after being added by the Importer.
void	setStylesOverwrite(EbiElementOverwrite overwrite) Sets the style overwrite options.
void	setTargetFolder(EbiDocFolder targetFolder) Sets the target folder for the import operation.
void	setZipInputStream(ZipInputStream zisData) Sets the input data source for the Importer to be an archive.

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

getAllResElements, getOperationDescriptor, getRepositoryID, getResCategories, getResDoctypes, getResDocuments, getResFields, getResFolders, getResLayoutStyles, getResLinks, setOperationDescriptor, setRepositoryID

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

clearAll, clearResults, clearSettings, execute, isInputSet

Field Detail

CM_IMPORT_LOG

public static final String CM_IMPORT_LOG

The name of the CM Import Log.

Method Detail

importDocuments

public Collection importDocuments(EbiContext context,
                                  InputStream inDocData)
                           throws EboUnrecoverableSystemException,
                                  EboSecurityException

Deprecated. See EbiTool.execute(EbiContext context).

Imports documents, given the XML describing Document data, into the Content Management System.

Parameters:

context - context

inDocData - document data, see contentmgmt-data_3_0.dtd

Returns:

a Collection of EbiDocument's which represent the imported Documents

Throws:

EboUnrecoverableSystemException - on an unrecoverable error

EboSecurityException - on a security error

Since:

v.3.0

setZipInputStream

public void setZipInputStream(ZipInputStream zisData)

Sets the input data source for the Importer to be an archive.

Parameters:

zisData - the zip input stream representing the archive file

getZipInputStream

public ZipInputStream getZipInputStream()

Returns the input zip input stream, if any was set

Returns:

the input zip input stream, or null if not set

setCheckOutDocs

public void setCheckOutDocs(boolean checkOut)

Specifies whether to check out all the imported documents to the user whose context is passed in to the execute() method.

Parameters:

checkOut - if true, check out all the imported documents to the user whose context is passed in to the execute() method

setPublishDocsImmediately

public void setPublishDocsImmediately(boolean publishImmediately)

Specifies whether documents should be published immediately after being added by the Importer.

Parameters:

publishImmediately - if true, publish documents as they are added

setCreateNonexistentFolders

public void setCreateNonexistentFolders(boolean create)

Sets the option to to create any folders that do not exist but whose URLs are mentioned in the input import XML such as the document XML. The default is not to create the nonexistent folders.

Parameters:

create - if true, create any folders that do not exist

setCreateNonexistentCategories

public void setCreateNonexistentCategories(boolean create)

Sets the option to to create any categories that do not exist but whose URLs are mentioned in the input import XML such as the document XML.

Parameters:

create - if true, create any categories that do not exist

setFieldsOverwrite

public void setFieldsOverwrite(EbiElementOverwrite overwrite)

Sets the field overwrite options.

Parameters:

overwrite - the field overwrite options

getFieldsOverwrite

public EbiElementOverwrite getFieldsOverwrite()

Returns the field overwrite options

Returns:

the field overwrite options

setDoctypesOverwrite

public void setDoctypesOverwrite(EbiElementOverwrite overwrite)

Sets the doctype overwrite options.

Parameters:

overwrite - the doctype overwrite options

getDoctypesOverwrite

public EbiElementOverwrite getDoctypesOverwrite()

Returns the doctype overwrite options.

Returns:

the doctype overwrite options

setStylesOverwrite

public void setStylesOverwrite(EbiElementOverwrite overwrite)

Sets the style overwrite options.

Parameters:

overwrite - the style overwrite options

getStylesOverwrite

public EbiElementOverwrite getStylesOverwrite()

Returns the style overwrite options.

setFoldersOverwrite

public void setFoldersOverwrite(EbiElementOverwrite overwrite)

Sets the folder overwrite options.

Parameters:

overwrite - the folder overwrite options

getFoldersOverwrite

public EbiElementOverwrite getFoldersOverwrite()

Returns the folder overwrite options.

Returns:

the folder overwrite options

setCategoriesOverwrite

public void setCategoriesOverwrite(EbiElementOverwrite overwrite)

Sets the category overwrite options.

Parameters:

overwrite - the category overwrite options

getCategoriesOverwrite

public EbiElementOverwrite getCategoriesOverwrite()

Returns the category overwrite options.

Returns:

the category overwrite options

setDocumentsOverwrite

public void setDocumentsOverwrite(EbiElementOverwrite overwrite)

Sets the document overwrite options.

Parameters:

overwrite - the document overwrite options

getDocumentsOverwrite

public EbiElementOverwrite getDocumentsOverwrite()

Returns the document overwrite options.

Returns:

the document overwrite options

setLinksOverwrite

public void setLinksOverwrite(EbiElementOverwrite overwrite)

Sets the link overwrite options

Parameters:

overwrite - the link overwrite options

getLinksOverwrite

public EbiElementOverwrite getLinksOverwrite()

Returns the link overwrite options.

Returns:

the link overwrite options

setTargetFolder

public void setTargetFolder(EbiDocFolder targetFolder)

Sets the target folder for the import operation.

Parameters:

targetFolder - the targer folder

getTargetFolder

public EbiDocFolder getTargetFolder()
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Returns the target folder (defaults to the Root Folder).

Returns:

the target folder, or the Root Folder if no target was set

mustCheckOutDocs

public boolean mustCheckOutDocs()

Tells whether the Importer is to check out any documents it creates at execution time, to the user whose context is set into the Importer via the setContext method.

Returns:

true if the Importer is to check out any documents it creates at execution time

mustPublishDocsImmediately

public boolean mustPublishDocsImmediately()

Tells whether any added documents must be published immediately.

Returns:

true if any added documents must be published immediately

mustCreateNonexistentFolders

public boolean mustCreateNonexistentFolders()

Tells whether the tool must create any non-existent folders.

Returns:

true if the tool must create any non-existent folders

mustCreateNonexistentCategories

public boolean mustCreateNonexistentCategories()

Tells whether the tool must create any non-existent categories.

Returns:

true if the tool must create any non-existent categories