com.atlassian.confluence.importexport

Interface ExportContext

All Known Implementing Classes:

DefaultExportContext

public interface ExportContext

Method Summary

Modifier and Type	Method and Description
String	getExportDirectoryPath() Deprecated. since 3.2 - unused
ExportScope	getExportScope()
Set	getProcessedIds()
String	getScope() Deprecated. since 4.2 use getExportScope()
String	getSpaceKeyOfSpaceExport()
String	getType()
com.atlassian.user.User	getUser()
List<ConfluenceEntityObject>	getWorkingEntities() The top level entities to be exported.
boolean	isExceptionEntity(ConfluenceEntityObject entity) Entities to be excluded from the export.
boolean	isExportAttachments()
boolean	isExportComments()
boolean	isExportHierarchy()
boolean	isPageInExport(Page page, PageManager pageManager)
void	setExportAttachments(boolean exportAttachments)
void	setExportHierarchy(boolean exportChildren)

Method Detail

isExportComments

boolean isExportComments()

isExportAttachments

boolean isExportAttachments()

setExportAttachments

void setExportAttachments(boolean exportAttachments)

isExportHierarchy

boolean isExportHierarchy()

setExportHierarchy

void setExportHierarchy(boolean exportChildren)

isExceptionEntity

boolean isExceptionEntity(ConfluenceEntityObject entity)

Entities to be excluded from the export.

getWorkingEntities

List<ConfluenceEntityObject> getWorkingEntities()

The top level entities to be exported. Their children and components will usually be exported too.

getProcessedIds

Set getProcessedIds()

getExportDirectoryPath

@Deprecated
String getExportDirectoryPath()

Deprecated. since 3.2 - unused

getExportScope

ExportScope getExportScope()

Returns:

the scope of an XML export: global, space or page.

getScope

@Deprecated
String getScope()

Deprecated. since 4.2 use getExportScope()

Returns:

the scope of an XML export: global, space or page. These string constants are defined on ImportExportManager.

getType

String getType()

Returns:

the type of the export: HTML, PDF or XML. These constants are defined above.

getUser

com.atlassian.user.User getUser()

Returns:

the user this export is being generated for.

getSpaceKeyOfSpaceExport

String getSpaceKeyOfSpaceExport()

Returns:

if this is a space export, the key of the space being exported, otherwise null

isPageInExport

boolean isPageInExport(Page page,
                       PageManager pageManager)

Returns:

true if the given page is part of the current export, otherwise false.