com.atlassian.confluence.importexport
Interface ExportContext

All Known Implementing Classes:
DefaultExportContext

public interface ExportContext


Method Summary
 DateFormatter getDateFormatter()
          Deprecated. since 2.8.2, use getUser() instead.
 java.lang.String getExportDirectoryPath()
           
 java.util.Set getProcessedIds()
           
 java.lang.String getScope()
           
 java.lang.String getType()
           
 com.atlassian.user.User getUser()
           
 java.util.List getWorkingEntities()
           
 boolean isExceptionEntity(ConfluenceEntityObject entity)
           
 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)

getWorkingEntities

java.util.List getWorkingEntities()

getProcessedIds

java.util.Set getProcessedIds()

getExportDirectoryPath

java.lang.String getExportDirectoryPath()

getScope

java.lang.String getScope()
Returns:
the scope of an XML export: global, space or page. These string constants are defined on ImportExportManager.

getType

java.lang.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.

getDateFormatter

DateFormatter getDateFormatter()
Deprecated. since 2.8.2, use getUser() instead.

Returns:
DateFormatter used to format dates and times in PDF & HTML exports.
See Also:
getUser()

isPageInExport

boolean isPageInExport(Page page,
                       PageManager pageManager)
Returns:
true if the given page is part of the current export, otherwise false.


Copyright © 2003-2009 Atlassian Pty Ltd. All Rights Reserved.