oracle.hsgbu.hdr.fwk.base

Interface CTBAttributeFetchMap

public interface CTBAttributeFetchMap

Method Summary

Modifier and Type	Method and Description
void	excludeAllAttributes() Excludes all attributes on the current value object and on all child objects through the entire value object hierarchy.
void	excludeAttribute(String attributeName) Excludes an attribute.
CTBAttributeFetchMap	getNestedAttrMap(String attributeName) Retrieves a nested CTBAttributeFetchMap based on a name.
void	includeAllAttributes() Includes all attributes on the current value object, and on all children through the entire value object hierarchy.
void	includeAttribute(String attributeName) Includes an attribute.

Method Detail

excludeAllAttributes

void excludeAllAttributes()

Excludes all attributes on the current value object and on all child objects through the entire value object hierarchy.

includeAllAttributes

void includeAllAttributes()

Includes all attributes on the current value object, and on all children through the entire value object hierarchy. By default, all attributes are included when the getAllAttributeFetchMap method retrieves CTBAttributeFetchMap.

excludeAttribute

void excludeAttribute(String attributeName)
               throws HDRRimException

Excludes an attribute. This method excludes the specified attribute from the value objects, which are returned by a fetch method. If the attribute name passed to this method represents a nested CTBAttributeFetchMap, all attributes (through the entire value object hierarchy) of that nested CTBAttributeFetchMap are excluded.

NOTE: This method can only be used to exclude immediate child attributes. It does not look for attributes through the entire value object hierarchy.

To retrieve CTBAttributeFetchMap objects further down the hierarchy, retrieve the nested CTBAttributeFetchMap level by level, by calling the getNestedAttrMap(java.lang.String) method on the nested CTBAttributeFetchMap.

Parameters:

attributeName - The name of the attribute to be excluded from the value object.

Throws:

HDRRimException

includeAttribute

void includeAttribute(String attributeName)
               throws HDRRimException

Includes an attribute. This method excludes the specified attribute in the value objects, which are returned by a fetch method. By default, all attributes are included when retrieving the CTBAttributeFetchMap object using the getAllAttributeFetchMap method. If the attribute name passed to this method represents a nested CTBAttributeFetchMap, all attributes (through the entire value object hierarchy) of that nested CTBAttributeFetchMap are included.

NOTE: This method can only be used to include immediate child attributes. It does not look for attributes through the entire value object hierarchy.

To retrieve CTBAttributeFetchMap objects further down the hierarchy, retrieve the nested CTBAttributeFetchMap objects level by level, by calling the getNestedAttrMap(java.lang.String) method on the nested CTBAttributeFetchMap.

Parameters:

attributeName - The name of the attribute to be included in the value object.

Throws:

HDRRimException

getNestedAttrMap

CTBAttributeFetchMap getNestedAttrMap(String attributeName)

Retrieves a nested CTBAttributeFetchMap based on a name.

NOTE: This method does not look for nested CTBAttributeFetchMap objects through the entire value object hierarchy. It looks only for immediate children. To retrieve CTBAttributeFetchMap objects further down the hierarchy, retrieve the nested CTBAttributeFetchMap objects level by level, by using getNestedAttrMap.

Parameters:

attributeName - The name of the attribute that represents the CTBAttributeFetchMap.

Returns:

The child CTBAttributeFetchMap object.