Package com.priint.pubserver.comet.integration

Interface ExportCometProjectCommand.AllOptional

Enclosing class:

ExportCometProjectCommand

public static interface ExportCometProjectCommand.AllOptional

Method Summary

Modifier and Type	Method	Description
ExportCometProjectCommand.AllOptional	abortOnAnyFailure(boolean abortOnFailure)	Specifies, if export should be aborted on any failure or not
ExportCometProjectCommand	build()	Finalizes the command setup
ExportCometProjectCommand.AllOptional	completion(ExportCometProjectCommand.StructureCompletion completion)	Specifies how to treat configurations not included in the export set
ExportCometProjectCommand.AllOptional	encryptScripts(boolean encryptScripts)	Specifies, whether to encrypt scripts or not
ExportCometProjectCommand.AllOptional	exportAllLibraries(boolean exportAllLibraries)	Specifies, whether all libraries and Plug-In stubs should be exported or only dependent
ExportCometProjectCommand.AllOptional	fetch(Set<ExportCometProjectCommand.ObtainableConfiguration> fetch)	Specifies, which files / configurations to export
ExportCometProjectCommand.AllOptional	languages(Set<String> languages)	Sets the languages to support
ExportCometProjectCommand.AllOptional	postFilter(Predicate<Comet3Entity> postFilter)	Sets a predicate to filter an item after transformation
ExportCometProjectCommand.AllOptional	preFilter(Predicate<CometEntity> preFilter)	Sets a predicate to test ond / or prefilter an item before transformation
ExportCometProjectCommand.AllOptional	purpose(ExportCometProjectCommand.Purpose purpose)	Sets the purpose of this export

Method Details

fetch

ExportCometProjectCommand.AllOptional fetch(Set<ExportCometProjectCommand.ObtainableConfiguration> fetch)

Specifies, which files / configurations to export

Specifies, which configurations to export. Default is to export everything (ExportCometProjectCommand.ObtainableConfiguration.all())

Parameters:

fetch - set of configurations to fetch

Returns:

command builder for next optional settings

completion

ExportCometProjectCommand.AllOptional completion(ExportCometProjectCommand.StructureCompletion completion)

Specifies how to treat configurations not included in the export set

Possible values are

• ExportCometProjectCommand.StructureCompletion.ALL: generate an 'empty' (null record only) configuration
• ExportCometProjectCommand.StructureCompletion.NONE: ignore missing types

Parameters:

completion - whether to generate empty configurations for missing types

Returns:

command builder for next optional settings

preFilter

ExportCometProjectCommand.AllOptional preFilter(Predicate<CometEntity> preFilter)

Sets a predicate to test ond / or prefilter an item before transformation

The preFilter predicate allows filter items, before being processed for the export. If the Predicate.test(Object) implementation returns false, the item will be skipped, otherwise it will be included in the export.

Default is to match all items.

Example:

         // ... builder().
         preFilter((item) -> {
              // if certain conditions match: skip this item
              return false;
         *         }). // ...
     

Parameters:

preFilter - predicate to test before exporting

Returns:

command builder for next optional settings

postFilter

ExportCometProjectCommand.AllOptional postFilter(Predicate<Comet3Entity> postFilter)

Sets a predicate to filter an item after transformation

The postFilter predicate allows to filter items, after being processed for the export. If the Predicate.test(Object) implementation returns false, the item will be skipped, otherwise it will be included in the export.

Default is to match all items.

Parameters:

postFilter - predicate to test before exporting

Returns:

command builder for next optional settings

encryptScripts

ExportCometProjectCommand.AllOptional encryptScripts(boolean encryptScripts)

Specifies, whether to encrypt scripts or not

Parameters:

encryptScripts - true, if scripts should be encrypted, false otherwise

Returns:

command builder for next optional settings

abortOnAnyFailure

ExportCometProjectCommand.AllOptional abortOnAnyFailure(boolean abortOnFailure)

Specifies, if export should be aborted on any failure or not

Parameters:

abortOnFailure - true, if export should be aborted on any failure, false otherwise

Returns:

command builder for the next optional setting

exportAllLibraries

ExportCometProjectCommand.AllOptional exportAllLibraries(boolean exportAllLibraries)

Specifies, whether all libraries and Plug-In stubs should be exported or only dependent

Parameters:

exportAllLibraries - true to export all libraries and Plug-In stubs, false otherwise

Returns:

command builder for next optional setting

languages

ExportCometProjectCommand.AllOptional languages(Set<String> languages)

Sets the languages to support

The language

• may affect certain labels
• controls, which message_languageRegion to export

If more than one language is defined, the first in the list is the default.
Language must be provided in the form 2 digit language + 2 digit region, e.g. "deDE" or "enEN".

Parameters:

languages - list of languages to support

Returns:

command builder for next optional setting

purpose

ExportCometProjectCommand.AllOptional purpose(ExportCometProjectCommand.Purpose purpose)

Sets the purpose of this export

See ExportCometProjectCommand.Purpose for details. Default is, to export for XML Offline usage (ExportCometProjectCommand.Purpose.XML_OFFLINE)

Parameters:

purpose - purpose of this export

Returns:

command builder for next optional setting

build

ExportCometProjectCommand build()

Finalizes the command setup

Returns:

export command