Package com.acrolinx.client.sdk.check

Class CheckOptionsBuilder

java.lang.Object

com.acrolinx.client.sdk.check.CheckOptionsBuilder

public class CheckOptionsBuilder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
CheckOptions	build()
CheckOptionsBuilder	withBatchId(java.lang.String batchId)	Optional.
CheckOptionsBuilder	withCheckType(CheckType checkType)	Optional.
CheckOptionsBuilder	withContentFormat(java.lang.String contentFormat)	Optional.
CheckOptionsBuilder	withGenerateReportTypes(java.util.List<ReportType> reportTypes)	Optional.
CheckOptionsBuilder	withGuidanceProfileId(java.lang.String guidanceProfileId)	Optional.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withGuidanceProfileId

public CheckOptionsBuilder withGuidanceProfileId(java.lang.String guidanceProfileId)

Optional. Available guidance profiles depend on your Acrolinx Platform configuration.

See Also:

AcrolinxEndpoint.getCapabilities(AccessToken)

withBatchId

public CheckOptionsBuilder withBatchId(java.lang.String batchId)

Optional. Per default a unique id is generated for each batch check. If you want to generate your own ids you can use this setting.

See Also:

BatchCheckIdGenerator

withGenerateReportTypes

public CheckOptionsBuilder withGenerateReportTypes(java.util.List<ReportType> reportTypes)

Optional. Per default a scorecard is generated for each check. Available report types depend on the current users permission and the Acrolinx Platform configuration.

See Also:

AcrolinxEndpoint.getCapabilities(AccessToken)

withCheckType

public CheckOptionsBuilder withCheckType(CheckType checkType)

Optional. Default setting is 'interactive'.

Parameters:

checkType - Based on the origin of check

Returns:

CheckOptionsBuilder

withContentFormat

public CheckOptionsBuilder withContentFormat(java.lang.String contentFormat)

Optional. Per default this is set to "AUTO" which enables the Acrolinx Platforms default mapping for input types to common file extensions.

See Also:

Input Types and Integrating with Multiformat Editors

build

public CheckOptions build()