oracle.communication.brm.charging.config.servicespec

Interface PayloadView

public interface PayloadView

Class exposes the immutable interface of a Payload. Users cannot modify the attributes and sub-blocks when using this interface.

Method Summary

Modifier and Type	Method and Description
PayloadBlockIterator<PayloadBlockView>	createViewIterator() method to createColumnInfo an iterator that will do a depth first traversal of all sub-blocks below this Payload.
PayloadBlockIterator<PayloadBlockView>	createViewIterator(java.lang.String blockName) method to createColumnInfo an iterator that will do a depth first traversal of all sub-blocks below this PayloadBlock that match the supplied blockName.
PayloadBlockIterator<PayloadBlockView>	createViewIterator(java.lang.String blockName, java.lang.String attrName) method to createColumnInfo an iterator that will do a depth first traversal of all sub-blocks below this PayloadBlock that match the supplied blockName and attribute name.
PayloadBlockIterator<PayloadBlockView>	createViewIterator(java.lang.String blockName, java.lang.String attrName, java.lang.String value) method to createColumnInfo an iterator that will do a depth first traversal of all sub-blocks below this PayloadBlock that match the supplied blockName.
<T> T	getAttribute(java.lang.String name) method returns the attribute value for the provided attribute name.
java.util.List<PayloadAttributeInfo>	getAttributeInfo() method returns meta data about all available attributes in this Payload.
PayloadAttributeInfo	getAttributeInfo(java.lang.String attributeName) method returns meta data about the attribute info for the given fully qualified attribute.
java.lang.String	getOperationType() method gets the applicable operation type for this Payload
java.util.List<PayloadBlockInfo>	getSubBlockInfo() method returns meta data about the PayloadBlocks in this Payload.
java.util.List<PayloadBlockView>	getSubBlocks(java.lang.String name) method gets the sub-block matching the supplied name.
boolean	hasAttribute(java.lang.String name) method used to see if the Payload contains an attribute for the supplied name.
java.lang.String	toDebugString() method will produce a detailed representation of a payload

Method Detail

getOperationType

java.lang.String getOperationType()

method gets the applicable operation type for this Payload

Returns:

the operation type for this PayloadSpec

getAttribute

<T> T getAttribute(java.lang.String name)

method returns the attribute value for the provided attribute name. ClassCastException will be thrown if caller attempts to retrieve the attribute as the incorrect data type. Dot notation addressing is supported in the supplied name.

Type Parameters:

T - the type of the expected attribute

Parameters:

name - the name of the attribute to be retrieved (eg. ABC[2].XYZ[1].TIME)

Returns:

the attribute value corresponding to the supplied name.

hasAttribute

boolean hasAttribute(java.lang.String name)

method used to see if the Payload contains an attribute for the supplied name.

Parameters:

name - name of the attribute in question.

Returns:

true if the payload contains an attribute for the supplied name.

createViewIterator

PayloadBlockIterator<PayloadBlockView> createViewIterator()

method to createColumnInfo an iterator that will do a depth first traversal of all sub-blocks below this Payload.

Returns:

iterator for all sub-blocks of this PayloadBlock.

createViewIterator

PayloadBlockIterator<PayloadBlockView> createViewIterator(java.lang.String blockName)

method to createColumnInfo an iterator that will do a depth first traversal of all sub-blocks below this PayloadBlock that match the supplied blockName.

Parameters:

blockName - block name to match. A trailing '*' suffix can be used to do wildcard helps. (eg. CUSTOMER.BALANCE*)

Returns:

iterator to traverse all sub-blocks of this PayloadBlock that match the supplied blockName.

createViewIterator

PayloadBlockIterator<PayloadBlockView> createViewIterator(java.lang.String blockName,
                                                          java.lang.String attrName)

method to createColumnInfo an iterator that will do a depth first traversal of all sub-blocks below this PayloadBlock that match the supplied blockName and attribute name.

Parameters:

blockName - block name to match. A trailing '*' suffix can be used to do wildcard helps. (eg. CUSTOMER.BALANCE*)

attrName - attr name to match.

Returns:

iterator to traverse all sub-blocks of this PayloadBlock that match the supplied blockName and attr name.

createViewIterator

PayloadBlockIterator<PayloadBlockView> createViewIterator(java.lang.String blockName,
                                                          java.lang.String attrName,
                                                          java.lang.String value)

method to createColumnInfo an iterator that will do a depth first traversal of all sub-blocks below this PayloadBlock that match the supplied blockName. attribute name and attribute value.

Parameters:

blockName - block name to match. A trailing '*' suffix can be used to do wildcard helps. (eg. CUSTOMER.BALANCE*)

attrName - attr name to match.

value - attr value to match.

Returns:

iterator to traverse all sub-blocks of this PayloadBlock that match the supplied blockName, attr name and attr value.

getSubBlocks

java.util.List<PayloadBlockView> getSubBlocks(java.lang.String name)

method gets the sub-block matching the supplied name. A List of immutable PayloadBlockViews are returned.

Parameters:

name - name of the block to get. Dot notation is NOT supported, this is a non-qualified block name that represents a block with is a direct descendant of this payload.

Returns:

the list of matching blocks. Empty collection is return if there are no child blocks available by the supplied name.

getAttributeInfo

java.util.List<PayloadAttributeInfo> getAttributeInfo()

method returns meta data about all available attributes in this Payload.

Returns:

meta data about all available attributes in this Payload

getAttributeInfo

PayloadAttributeInfo getAttributeInfo(java.lang.String attributeName)

method returns meta data about the attribute info for the given fully qualified attribute.

Parameters:

attributeName - name of teh attribute for which the attribute info will be returned

Returns:

meta data about all available attributes in this Payload

getSubBlockInfo

java.util.List<PayloadBlockInfo> getSubBlockInfo()

method returns meta data about the PayloadBlocks in this Payload.

Returns:

meta data about PayloadBlocks in this Payload

toDebugString

java.lang.String toDebugString()

method will produce a detailed representation of a payload

Returns:

engineer view of the payload