Package com.flower.docs.service.api.component.content.archive

Interface ArchiveService

All Superinterfaces:

JobService

public interface ArchiveService
extends JobService

Get the compressed content of a Component or Search.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getComponentContentAsync(com.flower.docs.domain.component.ComponentReference reference, java.lang.String format, boolean includeMetaData, boolean recursive, boolean flatten, java.lang.String fileName)	Get component content as archive from a ComponentReference asynchronously
javax.activation.DataHandler	getComponentContentSync(com.flower.docs.domain.component.ComponentReference reference, java.lang.String format, boolean includeMetaData, boolean recursive, boolean flatten, java.lang.String fileName)	Get component content as archive from a ComponentReference synchronously
java.lang.String	getComponentsContentAsync(java.util.List<com.flower.docs.domain.component.ComponentReference> references, java.lang.String format, boolean includeMetaData, boolean recursive, boolean flatten, java.lang.String fileName)	Get components content as archive from a list of ComponentReference asynchronously
javax.activation.DataHandler	getComponentsContentSync(java.util.List<com.flower.docs.domain.component.ComponentReference> references, java.lang.String format, boolean includeMetaData, boolean recursive, boolean flatten, java.lang.String fileName)	Get components content as archive from a list of ComponentReference synchronously
java.lang.String	getSearchContentAsync(com.flower.docs.domain.search.Search search, java.lang.String format, boolean includeMetaData, boolean recursive, boolean flatten)	Get found components content as archive from a search synchronously
javax.activation.DataHandler	getSearchContentSync(com.flower.docs.domain.search.Search search, java.lang.String format, boolean includeMetaData, boolean recursive, boolean flatten)	Get found components content as archive from a search synchronously

Methods inherited from interface com.flower.docs.service.api.job.JobService

getJobError, getJobResult, getJobStatus

Method Detail

getComponentContentSync

javax.activation.DataHandler getComponentContentSync(com.flower.docs.domain.component.ComponentReference reference,
                                                     java.lang.String format,
                                                     boolean includeMetaData,
                                                     boolean recursive,
                                                     boolean flatten,
                                                     java.lang.String fileName)
                                              throws com.flower.docs.domain.exception.FunctionalException,
                                                     com.flower.docs.domain.exception.TechnicalException

Get component content as archive from a ComponentReference synchronously

Parameters:

reference - The ComponentReference

format - The archive format (by default:zip)

includeMetadata - If true, include metadata of component(s). (by default:false)

recursive - If true, get component content recursively, otherwise keep only its children. (by default:false)

flatten - If true, keep component data structure, otherwise flatten it. (by default:false)

fileName - The name of build archive

Throws:

com.flower.docs.domain.exception.FunctionalException - If a functional error occurred

com.flower.docs.domain.exception.TechnicalException - If a technical error occurred

getComponentContentAsync

java.lang.String getComponentContentAsync(com.flower.docs.domain.component.ComponentReference reference,
                                          java.lang.String format,
                                          boolean includeMetaData,
                                          boolean recursive,
                                          boolean flatten,
                                          java.lang.String fileName)
                                   throws com.flower.docs.domain.exception.FunctionalException,
                                          com.flower.docs.domain.exception.TechnicalException

Get component content as archive from a ComponentReference asynchronously

Parameters:

reference - The ComponentReference

format - The archive format (by default:zip)

includeMetadata - If true, include metadata of component(s). (by default:false)

recursive - If true, get component content recursively, otherwise keep only its children. (by default:false)

flatten - If true, keep component data structure, otherwise flatten it. (by default:false)

fileName - The name of build archive

Throws:

com.flower.docs.domain.exception.FunctionalException - If a functional error occurred

com.flower.docs.domain.exception.TechnicalException - If a technical error occurred

getComponentsContentAsync

java.lang.String getComponentsContentAsync(java.util.List<com.flower.docs.domain.component.ComponentReference> references,
                                           java.lang.String format,
                                           boolean includeMetaData,
                                           boolean recursive,
                                           boolean flatten,
                                           java.lang.String fileName)
                                    throws com.flower.docs.domain.exception.TechnicalException,
                                           com.flower.docs.domain.exception.FunctionalException

Get components content as archive from a list of ComponentReference asynchronously

Parameters:

reference - The ComponentReference

format - The archive format (by default:zip)

includeMetadata - If true, include metadata of component(s). (by default:false)

recursive - If true, get component content recursively, otherwise keep only its children. (by default:false)

flatten - If true, keep component data structure, otherwise flatten it. (by default:false)

fileName - The name of build archive

Throws:

com.flower.docs.domain.exception.FunctionalException - If a functional error occurred

com.flower.docs.domain.exception.TechnicalException - If a technical error occurred

getComponentsContentSync

javax.activation.DataHandler getComponentsContentSync(java.util.List<com.flower.docs.domain.component.ComponentReference> references,
                                                      java.lang.String format,
                                                      boolean includeMetaData,
                                                      boolean recursive,
                                                      boolean flatten,
                                                      java.lang.String fileName)
                                               throws com.flower.docs.domain.exception.FunctionalException,
                                                      com.flower.docs.domain.exception.TechnicalException

Get components content as archive from a list of ComponentReference synchronously

Parameters:

reference - The ComponentReference

format - The archive format (by default:zip)

includeMetadata - If true, include metadata of component(s). (by default:false)

recursive - If true, get component content recursively, otherwise keep only its children. (by default:false)

flatten - If true, keep component data structure, otherwise flatten it. (by default:false)

fileName - The name of build archive

Throws:

com.flower.docs.domain.exception.FunctionalException - If a functional error occurred

com.flower.docs.domain.exception.TechnicalException - If a technical error occurred

getSearchContentSync

javax.activation.DataHandler getSearchContentSync(com.flower.docs.domain.search.Search search,
                                                  java.lang.String format,
                                                  boolean includeMetaData,
                                                  boolean recursive,
                                                  boolean flatten)
                                           throws com.flower.docs.domain.exception.FunctionalException,
                                                  com.flower.docs.domain.exception.TechnicalException

Get found components content as archive from a search synchronously

Parameters:

search - The search to find components

format - The archive format (by default:zip)

includeMetadata - If true, include metadata of component(s). (by default:false)

recursive - If true, get found components content recursively, otherwise keep only found components. (by default:false)

flatten - If true, keep component data structure, otherwise flatten it. (by default:false)

async - If true, get component content in an asynchronous way, otherwise in a synchronous way. (by default:false)

Throws:

com.flower.docs.domain.exception.FunctionalException - If a functional error occurred

com.flower.docs.domain.exception.TechnicalException - If a technical error occurred

getSearchContentAsync

java.lang.String getSearchContentAsync(com.flower.docs.domain.search.Search search,
                                       java.lang.String format,
                                       boolean includeMetaData,
                                       boolean recursive,
                                       boolean flatten)
                                throws com.flower.docs.domain.exception.FunctionalException,
                                       com.flower.docs.domain.exception.TechnicalException

Get found components content as archive from a search synchronously

Parameters:

search - The search to find components

format - The archive format (by default:zip)

includeMetadata - If true, include meta data of component(s). (by default:false)

recursive - If true, get found components content recursively, otherwise keep only found components. (by default:false)

flatten - If true, keep component data structure, otherwise flatten it. (by default:false)

async - If true, get component content in an asynchronous way, otherwise in a synchronous way. (by default:false)

Throws:

com.flower.docs.domain.exception.FunctionalException - If a functional error occurred

com.flower.docs.domain.exception.TechnicalException - If a technical error occurred