com.sssw.cm.api
Interface EbiDataTransfer

All Superinterfaces:

EbiTool, Serializable

All Known Subinterfaces:

EbiExporter, EbiImporter

public interface EbiDataTransfer

extends EbiTool

Describes the set of functionality that is common to various data transfer tools. NOTE: to be promoted in to com.sssw.fw.api if this is rendered as generic enough (minus the set/get repository ID and such).

Since:

v.4.0

Field Summary

static String	ADMIN_METADATA_PATH This directory inside the data transfer zip archive file contains any metadata that pertains to the CM Admin Element.
static String	CATEGORIES_METADATA_PATH This directory inside the data transfer zip archive file contains any metadata that pertains to categories.
static String	CONTENTMGMT_INF_PATH This directory inside the data transfer zip archive file contains any data transfer metadata information such as the data import descriptor file (contentmgmt_did.xml).
static String	DOCS_CONTENT_PATH This directory inside the data transfer zip archive file contains any published document content.
static String	DOCS_CONTENT_VERSIONS_PATH This directory inside the data transfer zip archive file contains any document content versions.
static String	DOCS_METADATA_PATH This directory inside the data transfer zip archive file contains any metadata that pertains to documents.
static String	DOCTYPES_DATA_PATH This directory inside the data transfer zip archive file contains any extension metadata files that belong to document types.
static String	DOCTYPES_METADATA_PATH This directory inside the data transfer zip archive file contains any metadata that pertains to document types.
static String	FIELDS_DATA_PATH This directory inside the data transfer zip archive file contains any extension metadata files that belong to extension metadata fields.
static String	FIELDS_METADATA_PATH This directory inside the data transfer zip archive file contains any metadata that pertains to the extension metadata fields.
static String	FOLDERS_METADATA_PATH This directory inside the data transfer zip archive file contains any metadata that pertains to folders.
static String	LINKS_DATA_PATH This directory inside the data transfer zip archive file contains any extension metadata for document links.
static String	LINKS_METADATA_PATH This directory inside the data transfer zip archive file contains any metadata that pertains to document links.
static String	STYLES_METADATA_PATH This directory inside the data transfer zip archive file contains any metadata that pertains to document layout styles.

Method Summary

Collection	getAllResElements() Returns a Collection of CM elements that were successfully processed last time the data transfer tool executed.
Document	getOperationDescriptor() Gets the operation descriptor.
String	getRepositoryID() Gets the repository ID.
Collection	getResCategories() Returns a Collection of categories that were successfully processed last time the data transfer tool executed.
Collection	getResDoctypes() Returns a Collection of document types that were successfully processed last time the data transfer tool executed.
Collection	getResDocuments() Returns a Collection of documents that were successfully processed last time the data transfer tool executed.
Collection	getResFields() Returns a Collection of CM document fields that were successfully processed last time the data transfer tool executed.
Collection	getResFolders() Returns a Collection of folders that were successfully processed last time the data transfer tool executed.
Collection	getResLayoutStyles() Returns a Collection of document layout styles that were successfully processed last time the data transfer tool executed.
Collection	getResLinks() Returns a Collection of document links that were successfully processed last time the data transfer tool executed.
void	setOperationDescriptor(Document docOpDescriptor) Sets the operation descriptor.
void	setRepositoryID(String repositoryID) Sets the repository ID.

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

clearAll, clearResults, clearSettings, execute, isInputSet

Field Detail

CONTENTMGMT_INF_PATH

public static final String CONTENTMGMT_INF_PATH

This directory inside the data transfer zip archive file contains any data transfer metadata information such as the data import descriptor file (contentmgmt_did.xml). The actual directory name is "CONTENTMGMT-INF".

FIELDS_METADATA_PATH

public static final String FIELDS_METADATA_PATH

This directory inside the data transfer zip archive file contains any metadata that pertains to the extension metadata fields. The actual directory name is "fields_metadata".

FIELDS_DATA_PATH

public static final String FIELDS_DATA_PATH

This directory inside the data transfer zip archive file contains any extension metadata files that belong to extension metadata fields. The actual directory name is "fields_data".

DOCTYPES_METADATA_PATH

public static final String DOCTYPES_METADATA_PATH

This directory inside the data transfer zip archive file contains any metadata that pertains to document types. The actual directory name is "doctypes_metadata".

DOCTYPES_DATA_PATH

public static final String DOCTYPES_DATA_PATH

This directory inside the data transfer zip archive file contains any extension metadata files that belong to document types. The actual directory name is "doctypes_data".

STYLES_METADATA_PATH

public static final String STYLES_METADATA_PATH

This directory inside the data transfer zip archive file contains any metadata that pertains to document layout styles. The actual directory name is "styles_metadata".

FOLDERS_METADATA_PATH

public static final String FOLDERS_METADATA_PATH

This directory inside the data transfer zip archive file contains any metadata that pertains to folders. The actual directory name is "folders_metadata".

CATEGORIES_METADATA_PATH

public static final String CATEGORIES_METADATA_PATH

This directory inside the data transfer zip archive file contains any metadata that pertains to categories. The actual directory name is "categories_metadata".

DOCS_METADATA_PATH

public static final String DOCS_METADATA_PATH

This directory inside the data transfer zip archive file contains any metadata that pertains to documents. The actual directory name is "docs_metadata".

DOCS_CONTENT_PATH

public static final String DOCS_CONTENT_PATH

This directory inside the data transfer zip archive file contains any published document content. The actual directory name is "docs_content".

DOCS_CONTENT_VERSIONS_PATH

public static final String DOCS_CONTENT_VERSIONS_PATH

This directory inside the data transfer zip archive file contains any document content versions. Note that the metadata describing the versions is contained within the document metadata (see DOCS_METADATA_PATH); this directory contains the actual document content for versions. The actual directory name is "docs_content_versions".

LINKS_METADATA_PATH

public static final String LINKS_METADATA_PATH

This directory inside the data transfer zip archive file contains any metadata that pertains to document links. The actual directory name is "links_metadata".

LINKS_DATA_PATH

public static final String LINKS_DATA_PATH

This directory inside the data transfer zip archive file contains any extension metadata for document links. The actual directory name is "links_data".

ADMIN_METADATA_PATH

public static final String ADMIN_METADATA_PATH

This directory inside the data transfer zip archive file contains any metadata that pertains to the CM Admin Element. The actual directory name is "admin_metadata".

Method Detail

setRepositoryID

public void setRepositoryID(String repositoryID)

Sets the repository ID.

Parameters:

repositoryID - the ID of the CM repository to associate with this object

getRepositoryID

public String getRepositoryID()

Gets the repository ID.

Returns:

the ID of the CM repository that this object is associated with

setOperationDescriptor

public void setOperationDescriptor(Document docOpDescriptor)

Sets the operation descriptor. This needs to happen prior to the execute method being called.

Parameters:

docOpDescriptor - the XML descriptor for the operation

getOperationDescriptor

public Document getOperationDescriptor()

Gets the operation descriptor.

Returns:

the XML descriptor for the operation, or null if not set

getAllResElements

public Collection getAllResElements()

Returns a Collection of CM elements that were successfully processed last time the data transfer tool executed.

Returns:

a Collection of CM elements that were successfully processed last time the data transfer tool executed

getResFields

public Collection getResFields()

Returns a Collection of CM document fields that were successfully processed last time the data transfer tool executed.

Returns:

a Collection of CM document fields that were successfully processed last time the data transfer tool executed

getResDoctypes

public Collection getResDoctypes()

Returns a Collection of document types that were successfully processed last time the data transfer tool executed.

Returns:

a Collection of document types that were successfully processed last time the data transfer tool executed

getResLayoutStyles

public Collection getResLayoutStyles()

Returns a Collection of document layout styles that were successfully processed last time the data transfer tool executed.

Returns:

a Collection of document layout styles that were successfully processed last time the data transfer tool executed

getResFolders

public Collection getResFolders()

Returns a Collection of folders that were successfully processed last time the data transfer tool executed.

Returns:

a Collection of folders that were successfully processed last time the data transfer tool executed

getResCategories

public Collection getResCategories()

Returns a Collection of categories that were successfully processed last time the data transfer tool executed.

Returns:

a Collection of categories that were successfully processed last time the data transfer tool executed

getResDocuments

public Collection getResDocuments()

Returns a Collection of documents that were successfully processed last time the data transfer tool executed.

Returns:

a Collection of documents that were successfully processed last time the data transfer tool executed

getResLinks

public Collection getResLinks()

Returns a Collection of document links that were successfully processed last time the data transfer tool executed.

Returns:

a Collection of document links that were successfully processed last time the data transfer tool executed