com.hcl.voltmx.middleware.api

Interface OperationDataBuilder

public interface OperationDataBuilder

The builder for operation data.

Since:

Foundry V8 SP2 (8.2)

See Also:

OperationData

Method Summary

Modifier and Type	Method and Description
OperationData	build() Builds the OperationData.
OperationData	buildQuietly() Builds the OperationData.
String	getHttpMethod() Returns the HTTP method.
String	getVerison() Deprecated.
String	getVersion() Gets the service version.
OperationDataBuilder	withObjectId(String objectId) Adds object id info to the OperationData being built.
OperationDataBuilder	withOperation(OperationsEnum operation) Deprecated.
OperationDataBuilder	withOperationId(String operationId) Adds operation id info to the OperationData being built.
OperationDataBuilder	withServiceId(String serviceId) Adds service id info to the OperationData being built.
OperationDataBuilder	withVerison(String version) Deprecated.
OperationDataBuilder	withVersion(String version) Adds version info to the OperationData being built.

Method Detail

withServiceId

OperationDataBuilder withServiceId(String serviceId)

Adds service id info to the OperationData being built.

Parameters:

serviceId - The service id

Returns:

This builder

withOperationId

OperationDataBuilder withOperationId(String operationId)

Adds operation id info to the OperationData being built.

Parameters:

operationId - The operation id

Returns:

This builder

withObjectId

OperationDataBuilder withObjectId(String objectId)

Adds object id info to the OperationData being built.

FOR INTERNAL USE ONLY

Parameters:

objectId - The object id

Returns:

This builder

withOperation

@Deprecated
OperationDataBuilder withOperation(OperationsEnum operation)

Deprecated.

Adds operation info to the OperationData being built. This is deprecated since Foundry V8 SP3 (8.3).

FOR INTERNAL USE ONLY

Parameters:

operation - The operation

Returns:

This builder

See Also:

withOperationId(String)

withVersion

OperationDataBuilder withVersion(String version)

Adds version info to the OperationData being built.

Parameters:

version - The version

Returns:

This builder

withVerison

@Deprecated
OperationDataBuilder withVerison(String version)

Deprecated.

Adds version info to the OperationData being built. This is deprecated since Foundry V8 SP3 (8.3).

Parameters:

version - The version

Returns:

This builder

See Also:

withVersion(String)

getVersion

String getVersion()

Gets the service version.

Returns:

The service version.

Since:

Foundry V8 SP3 (8.3)

getHttpMethod

String getHttpMethod()

Returns the HTTP method.

Returns:

The HTTP method.

Since:

Foundry V8 SP4 (8.4)

getVerison

@Deprecated
String getVerison()

Deprecated.

Gets service version. This is deprecated since Foundry V8 SP3 (8.3).

Returns:

The service version.

See Also:

getVersion()

build

OperationData build()
             throws AppRegistryException

Builds the OperationData.

Returns:

The operation data

Throws:

AppRegistryException - on error

buildQuietly

OperationData buildQuietly()

Builds the OperationData.

Returns:

The operation data