Package oracle.communication.brm.charging.config.servicespec

Interface PayloadSpec

public interface PayloadSpec

This class is the interface for a PayloadSpecification

Method Summary

Modifier and Type	Method	Description
Payload	createPayload(String operation)	method creates a new instance of a Payload from the Payload Specification.
List<String>	getOperationTypes()	method gets the applicable operation types for this PayloadSpec
String	toParserStringFormat()	method will produce a pretty formatted representation of a payload that is easily understandable by clients.
PayloadView	toPayloadView()	method will expose the Specification's Payload.

Method Details

getOperationTypes

List<String> getOperationTypes()

method gets the applicable operation types for this PayloadSpec

Returns:

the applicable operation types for this PayloadSpec

createPayload

Payload createPayload(String operation)

method creates a new instance of a Payload from the Payload Specification. The newly created payload can be modified by the caller to contain the desired AOM attributes.

Parameters:

operation - the operation to which the Payload is applicable.

Returns:

the newly created Payload.

toPayloadView

PayloadView toPayloadView()

method will expose the Specification's Payload. This represents the Payload as it was entered in the RequestSpecification input. This is useful when calling getAttributeInfo() and getBlockInfo() to introspect the Payload for meta data.

Returns:

the Specification's Payload.

toParserStringFormat

String toParserStringFormat()

method will produce a pretty formatted representation of a payload that is easily understandable by clients.

Returns:

nicely formatted string representing a payload