Package io.vertigo.vega.webservice.definitions

Class WebServiceParamBuilder

java.lang.Object

io.vertigo.vega.webservice.definitions.WebServiceParamBuilder

All Implemented Interfaces:

io.vertigo.core.lang.Builder<WebServiceParam>

public final class WebServiceParamBuilder
extends Object
implements io.vertigo.core.lang.Builder<WebServiceParam>

WebServiceParam Builder.

Author:

npiedeloup

Method Summary

Modifier and Type	Method	Description
WebServiceParamBuilder	addExcludedFields(String... excludedFields)
WebServiceParamBuilder	addIncludedFields(String... includedFields)
WebServiceParamBuilder	addValidatorClasses(Class<? extends DtObjectValidator>... validatorClasses)
WebServiceParam	build()
WebServiceParamBuilder	consumeServerSideToken()	If serverSide token is consume
WebServiceParamBuilder	needServerSideToken()	If serverSide token is needed and used
WebServiceParamBuilder	optional()	Force this WebServiceParam as optional
WebServiceParamBuilder	with(WebServiceParam.WebServiceParamType restParamType, String restParamName)

Methods inherited from class java.lang.Object

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

Method Details

with

public WebServiceParamBuilder with(WebServiceParam.WebServiceParamType restParamType,
 String restParamName)

Parameters:

restParamType - paramType

restParamName - paramName

Returns:

Builder

addValidatorClasses

public WebServiceParamBuilder addValidatorClasses(Class<? extends DtObjectValidator>... validatorClasses)

Parameters:

validatorClasses - List of validator to check

Returns:

Builder

addExcludedFields

public WebServiceParamBuilder addExcludedFields(String... excludedFields)

Parameters:

excludedFields - List of exluded fields

Returns:

Builder

addIncludedFields

public WebServiceParamBuilder addIncludedFields(String... includedFields)

Parameters:

includedFields - list of included fields (empty means all fields included)

Returns:

Builder

needServerSideToken

public WebServiceParamBuilder needServerSideToken()

If serverSide token is needed and used

Returns:

Builder

consumeServerSideToken

public WebServiceParamBuilder consumeServerSideToken()

If serverSide token is consume

Returns:

Builder

optional

public WebServiceParamBuilder optional()

Force this WebServiceParam as optional

Returns:

Builder

build

public WebServiceParam build()

Specified by:

build in interface io.vertigo.core.lang.Builder<WebServiceParam>