com.sssw.cm.api
Interface EbiExporter

All Superinterfaces:

EbiDataTransfer, EbiTool, Serializable

public interface EbiExporter

extends EbiDataTransfer

Objects that implement this interface are used for exporting CM data out of the Content Management System.

Since:

v.4.0

Field Summary

static String

CM_EXPORT_LOG The name of the CM Export 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

EbiQueryBase	getDocumentQuery() Returns the document scope query, if any was set via the selectDocuments method.
EbiQueryBase	getLinkQuery() Returns the document link query, if any was set via the selectLinks method.
OutputStream	getOutputStream() Returns the output stream that the exporter is set up to write its output data into.
EbiDocCategory[]	getSelectedCategories() Returns the list of selected categories.
EbiDocType[]	getSelectedDoctypes() Returns the list of selected document types.
EbiDocument[]	getSelectedDocuments() Returns the list of selected documents.
EbiDocField[]	getSelectedFields() Returns the list of selected fields, if any.
EbiDocFolder[]	getSelectedFolders() Returns the list of selected folders, if any.
EbiDocLink[]	getSelectedLinks() Returns the list of selected document links, if any.
EbiDocLayoutStyle[]	getSelectedStyles() Returns the list of selected layout styles, if any.
boolean	mustExportAll() Tells whether all CM elements are selected for export.
boolean	mustExportAllCategories() Tells whether all categories are to be exported.
boolean	mustExportAllDoctypes() Tells whether all doctypes are to be exported.
boolean	mustExportAllDocuments() Tells whether all documents are to be exported.
boolean	mustExportAllFields() Tells whether all fields are to be exported.
boolean	mustExportAllFolders() Tells whether all folders are to be exported.
boolean	mustExportAllLinks() Tells whether all document links are to be exported.
boolean	mustExportAllStyles() Tells whether all document layout styles are to be exported.
boolean	mustExportCategories() Tells whether any categories are to be exported.
boolean	mustExportContentAdmin() Tells whether the Content Admin element is to be exported.
boolean	mustExportDoctypes() Tells whether any document types are to be exported.
boolean	mustExportDocuments() Tells whether any documents are to be exported.
boolean	mustExportFields() Tells whether any fields are to be exported.
boolean	mustExportFolders() Tells whether any folders are to be exported.
boolean	mustExportStyles() Tells whether any styles are to be exported.
boolean	mustUseElementIDs() Tells whether CM element UUIDs are to be used in the output element XML.
void	selectAllCategories(boolean selectAll) Selects all categories for export.
void	selectAllDoctypes(boolean selectAll) Selects all document types for export.
void	selectAllDocuments(boolean selectAll) Selects all documents for export.
void	selectAllElements(boolean selectAll) Selects all CM elements for export.
void	selectAllFields(boolean selectAll) Selects all fields for export.
void	selectAllFolders(boolean selectAll) Selects all folders for export.
void	selectAllLinks(boolean selectAll) Selects all document links for export.
void	selectAllStyles(boolean selectAll) Selects all layout styles for export.
void	selectCategories(EbiDocCategory[] categories) Selects a set of categories to be exported.
void	selectCategory(EbiDocCategory category, boolean recursive) Selects a specific category for export.
void	selectContentAdmin(boolean select) Selects the Content Admin element for export.
void	selectDoctype(EbiDocType doctype) Selects a specific doctype for export.
void	selectDoctypes(EbiDocType[] doctypes) Selects a set of doctypes to be exported.
void	selectDocument(EbiDocument document) Selects a specific document for export.
void	selectDocuments(EbiDocument[] documents) Selects a set of documents for export.
void	selectDocuments(EbiQueryBase query) Selects documents for export by providing a query that is to be run in order to determine the scope of documents to be exported
void	selectElement(EbiContext context, String elSpec, boolean elSpecIsUUID, String elType, boolean includeSuppStructs, boolean includeDependencies) Selects a specific CM element for export.
void	selectField(EbiDocField field) Selects a specific field for export.
void	selectFields(EbiDocField[] fields) Selects a set of fields for export.
void	selectFolder(EbiDocFolder folder, boolean recursive) Selects a specific folder for export.
void	selectFolders(EbiDocFolder[] folders) Selects a set of folders for export.
void	selectLinks(EbiDocLink[] links) Selects a set of document links for export.
void	selectLinks(EbiQueryBase query, boolean asLinkChildren) Selects a set of document links for export.
void	selectStyle(EbiDocLayoutStyle style) Selects a specific layout style for export.
void	selectStyles(EbiDocLayoutStyle[] styles) Selects a set of document layout styles for export.
void	setOutputStream(OutputStream os) Sets the output stream to write the export data into.
void	setUseElementIDs(boolean useIDs) Sets the option for whether CM element UUIDs are to be used in the output element XML.

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_EXPORT_LOG

public static final String CM_EXPORT_LOG

The name of the CM Export Log.

Method Detail

selectAllFields

public void selectAllFields(boolean selectAll)

Selects all fields for export.

Parameters:

selectAll - if true, all fields are selected for export, otherwise the option 'select all fields' is turned off

mustExportAllFields

public boolean mustExportAllFields()

Tells whether all fields are to be exported.

Returns:

true if all fields are to be exported

mustExportFields

public boolean mustExportFields()

Tells whether any fields are to be exported.

Returns:

true if any fields are to be exported

selectFields

public void selectFields(EbiDocField[] fields)
                  throws EboUnrecoverableSystemException,
                         EboSecurityException

Selects a set of fields for export.

Parameters:

fields - the list of fields to export

selectField

public void selectField(EbiDocField field)
                 throws EboUnrecoverableSystemException,
                        EboSecurityException

Selects a specific field for export.

Parameters:

field - the field to export

getSelectedFields

public EbiDocField[] getSelectedFields()

Returns the list of selected fields, if any.

Returns:

the list of selected fields; empty if none selected

selectAllDoctypes

public void selectAllDoctypes(boolean selectAll)

Selects all document types for export.

Parameters:

selectAll - if true, all document types are selected for export, otherwise the option 'select all document types' is turned off

selectDoctype

public void selectDoctype(EbiDocType doctype)
                   throws EboUnrecoverableSystemException,
                          EboSecurityException

Selects a specific doctype for export.

Parameters:

doctype - the doctype to export

mustExportAllDoctypes

public boolean mustExportAllDoctypes()

Tells whether all doctypes are to be exported.

Returns:

true if all doctypes are to be exported

mustExportDoctypes

public boolean mustExportDoctypes()

Tells whether any document types are to be exported.

Returns:

true if any document types are to be exported

selectDoctypes

public void selectDoctypes(EbiDocType[] doctypes)
                    throws EboUnrecoverableSystemException,
                           EboSecurityException

Selects a set of doctypes to be exported.

Parameters:

doctypes - the doctypes to be exported

getSelectedDoctypes

public EbiDocType[] getSelectedDoctypes()

Returns the list of selected document types.

Returns:

the list of selected document types

selectAllStyles

public void selectAllStyles(boolean selectAll)

Selects all layout styles for export.

Parameters:

selectAll - if true, all layout styles are selected for export, otherwise the option 'select all layout styles' is turned off

selectStyle

public void selectStyle(EbiDocLayoutStyle style)
                 throws EboUnrecoverableSystemException,
                        EboSecurityException

Selects a specific layout style for export.

Parameters:

style - the style to export

mustExportAllStyles

public boolean mustExportAllStyles()

Tells whether all document layout styles are to be exported.

Returns:

true if all document layout styles are to be exported

mustExportStyles

public boolean mustExportStyles()

Tells whether any styles are to be exported.

Returns:

true if any styles are to be exported

selectStyles

public void selectStyles(EbiDocLayoutStyle[] styles)
                  throws EboUnrecoverableSystemException,
                         EboSecurityException

Selects a set of document layout styles for export.

Parameters:

styles - the styles to export

getSelectedStyles

public EbiDocLayoutStyle[] getSelectedStyles()

Returns the list of selected layout styles, if any.

Returns:

the list of selected layout styles; empty if none selected

selectAllFolders

public void selectAllFolders(boolean selectAll)

Selects all folders for export.

Parameters:

selectAll - if true, all folders are selected for export, otherwise the option 'select all folders' is turned off

mustExportAllFolders

public boolean mustExportAllFolders()

Tells whether all folders are to be exported.

Returns:

true if all folders are to be exported

selectFolder

public void selectFolder(EbiDocFolder folder,
                         boolean recursive)
                  throws EboUnrecoverableSystemException,
                         EboSecurityException

Selects a specific folder for export.

Parameters:

folder - the folder to export

recursive - if true, all the descendant folders are exported as well

mustExportFolders

public boolean mustExportFolders()

Tells whether any folders are to be exported.

Returns:

true if any folders are to be exported

selectFolders

public void selectFolders(EbiDocFolder[] folders)
                   throws EboUnrecoverableSystemException,
                          EboSecurityException

Selects a set of folders for export.

Parameters:

folders - the list of folders to export

getSelectedFolders

public EbiDocFolder[] getSelectedFolders()

Returns the list of selected folders, if any.

Returns:

the list of selected folders; empty if none selected

selectAllCategories

public void selectAllCategories(boolean selectAll)

Selects all categories for export.

Parameters:

selectAll - if true, all categories are selected for export, otherwise the 'select all categories' option is turned off

selectCategory

public void selectCategory(EbiDocCategory category,
                           boolean recursive)
                    throws EboUnrecoverableSystemException,
                           EboSecurityException

Selects a specific category for export.

Parameters:

category - the category to export

recursive - if true, all descendant categories are exported as well

mustExportAllCategories

public boolean mustExportAllCategories()

Tells whether all categories are to be exported.

Returns:

true if all categories are to be exported

mustExportCategories

public boolean mustExportCategories()

Tells whether any categories are to be exported.

Returns:

true if any categories are to be exported

selectCategories

public void selectCategories(EbiDocCategory[] categories)
                      throws EboUnrecoverableSystemException,
                             EboSecurityException

Selects a set of categories to be exported.

Parameters:

categories - the list of categories to be exported

getSelectedCategories

public EbiDocCategory[] getSelectedCategories()

Returns the list of selected categories.

Returns:

the list of selected categories

selectAllDocuments

public void selectAllDocuments(boolean selectAll)

Selects all documents for export.

Parameters:

selectAll - if true, all documents are selected for export, otherwise the option 'select all documents' is turned off

selectDocument

public void selectDocument(EbiDocument document)
                    throws EboUnrecoverableSystemException,
                           EboSecurityException

Selects a specific document for export.

Parameters:

document - the document to export

mustExportAllDocuments

public boolean mustExportAllDocuments()

Tells whether all documents are to be exported.

Returns:

true if all documents are to be exported

mustExportDocuments

public boolean mustExportDocuments()

Tells whether any documents are to be exported.

Returns:

true if any documents are to be exported

selectDocuments

public void selectDocuments(EbiDocument[] documents)
                     throws EboUnrecoverableSystemException,
                            EboSecurityException

Selects a set of documents for export.

Parameters:

documents - the list of documents to be exported

getSelectedDocuments

public EbiDocument[] getSelectedDocuments()

Returns the list of selected documents.

Returns:

the list of selected documents

selectDocuments

public void selectDocuments(EbiQueryBase query)

Selects documents for export by providing a query that is to be run in order to determine the scope of documents to be exported

Parameters:

query - the query to run (scope)

getDocumentQuery

public EbiQueryBase getDocumentQuery()

Returns the document scope query, if any was set via the selectDocuments method.

Returns:

the document scope query; null if none was set

selectContentAdmin

public void selectContentAdmin(boolean select)
                        throws EboUnrecoverableSystemException,
                               EboSecurityException

Selects the Content Admin element for export.

Parameters:

select - if true, the Content Admin element is selected for export; otherwise it is deselected (the default is 'not selected')

mustExportContentAdmin

public boolean mustExportContentAdmin()

Tells whether the Content Admin element is to be exported.

Returns:

true if the Content Admin element is to be exported

selectAllLinks

public void selectAllLinks(boolean selectAll)

Selects all document links for export.

Parameters:

selectAll - if true, all document links are selected for export, otherwise the option 'select all document links for export' is turned off

mustExportAllLinks

public boolean mustExportAllLinks()

Tells whether all document links are to be exported.

Returns:

true if all document links are to be exported

selectLinks

public void selectLinks(EbiDocLink[] links)
                 throws EboUnrecoverableSystemException,
                        EboSecurityException

Selects a set of document links for export.

Parameters:

links - the list of links to export

getSelectedLinks

public EbiDocLink[] getSelectedLinks()

Returns the list of selected document links, if any.

Returns:

the list of selected document links; empty if none selected

selectLinks

public void selectLinks(EbiQueryBase query,
                        boolean asLinkChildren)

Selects a set of document links for export.

Parameters:

query - the query to define the set of documents for which the links are to be exported

asLinkChildren - if true, the documents scoped by the query parameter, are assumed to be link-children, otherwise link-parents for the selected links

getLinkQuery

public EbiQueryBase getLinkQuery()

Returns the document link query, if any was set via the selectLinks method.

Returns:

the document link query; null if none was set

selectAllElements

public void selectAllElements(boolean selectAll)
                       throws EboUnrecoverableSystemException,
                              EboSecurityException

Selects all CM elements for export. This includes the following:

• Fields;
• Document types;
• Layout styles;
• Folders;
• Categories;
• Documents;
• Document links;
• the Content Admin element

Parameters:

selectAll - if true, all elements are selected; if false, the "select all elements" option is turned off

mustExportAll

public boolean mustExportAll()

Tells whether all CM elements are selected for export.

Returns:

true if all CM elements are selected for export, false if only some elements or none are selected

selectElement

public void selectElement(EbiContext context,
                          String elSpec,
                          boolean elSpecIsUUID,
                          String elType,
                          boolean includeSuppStructs,
                          boolean includeDependencies)
                   throws EboUnrecoverableSystemException,
                          EboSecurityException

Selects a specific CM element for export. The element is specified by its UUID or URL, as appropriate, plus the element type:

• Field -- UUID or name;
• Document type -- UUID or name;
• Layout style -- UUID;
• Folder -- UUID or URL;
• Category -- UUID or URL;
• Document -- UUID or URL;
• Document link -- not supported by this method;
• the Content Admin element -- element spec is ignored, supply the element type of EbiContentAdmin.EL_CONTENT_ADMIN

Parameters:

context - the context

elSpec - the element specifier

elSpecIsUUID - if true, the element specifier is assumed to be the element's UUID, otherwise it's assumed to be its name or URL

elType - the element type (see com.sssw.fw.api.EbiElement.getType())

includeSuppStructs - if true, all the supporting structures are included

includeDependencies - if true, all the dependent structures are included

setOutputStream

public void setOutputStream(OutputStream os)

Sets the output stream to write the export data into.

Parameters:

os - the output stream to write the export data into

getOutputStream

public OutputStream getOutputStream()

Returns the output stream that the exporter is set up to write its output data into.

Returns:

the output stream or null if none set

setUseElementIDs

public void setUseElementIDs(boolean useIDs)

Sets the option for whether CM element UUIDs are to be used in the output element XML. The default is not to use them.

Parameters:

useIDs - if true, element UUIDs are used in the output element XML, otherwise, only element names/URLs, as appropriate, are used to identify elements

mustUseElementIDs

public boolean mustUseElementIDs()

Tells whether CM element UUIDs are to be used in the output element XML. The default is not to use them.

Returns:

true if CM element UUIDs are to be used in the output element XML