oracle.apps.fnd.applcore.oaext.model
Interface KFFCombinationAttributes

All Known Implementing Classes:

KFFMViewRowImpl

public interface KFFCombinationAttributes

An interface for managing combination attributes.

Method Summary

java.lang.Long	getCodeCombinationID() Gets the code-combination ID.
java.util.List<FlexfieldSegmentValue>	getSegmentValues() Gets the segment values with the standard value attributes.
java.util.List<FlexfieldSegmentValue>	getSegmentValues(java.lang.String labelCode) Gets the segment values with their value attribute values for a label.
java.util.Iterator<java.lang.String>	getValueAttrCodeIterator(java.lang.String labelCode) Gets the iterator of the value attribute codes for a label.
java.lang.Object	getValueAttribute(java.lang.String labelCode, java.lang.String valAttrCode) Gets the current value of a value attribute of this combination.
void	printAllValueAttributes(java.io.PrintStream out) Prints the information of all value attributes.
void	setValueAttributes(java.util.Map<java.lang.String,java.lang.Object> values) Sets the standard value attributes.
void	setValueAttributes(java.lang.String labelCode, java.util.Map<java.lang.String,java.lang.Object> values) Sets the value attributes.

Method Detail

getSegmentValues

java.util.List<FlexfieldSegmentValue> getSegmentValues(java.lang.String labelCode)

Gets the segment values with their value attribute values for a label.

Parameters:

labelCode - the label code

Returns:

the segment values with value attribute values; an empty list if no segment is associated with the given label

Throws:

java.lang.IllegalArgumentException - if the given label code is null

getSegmentValues

java.util.List<FlexfieldSegmentValue> getSegmentValues()

Gets the segment values with the standard value attributes. The codes of the standard value attributes are defined as constants in FlexfieldSegmentValue.

Returns:

the segment values with the standard value attribute values; this list should include all flexfield segments because standard value attributes exist for all segment values.

getValueAttrCodeIterator

java.util.Iterator<java.lang.String> getValueAttrCodeIterator(java.lang.String labelCode)

Gets the iterator of the value attribute codes for a label. This method never returns null. If the label is undefined, unused or has no value attributes, an iterator with zero element is returned.

Parameters:

labelCode - the label code

Returns:

the iterator of the value attribute codes

Throws:

java.lang.IllegalArgumentException - if the given label code is null

getValueAttribute

java.lang.Object getValueAttribute(java.lang.String labelCode,
                                   java.lang.String valAttrCode)

Gets the current value of a value attribute of this combination.

Parameters:

labelCode - the label code; null if the given value attribute code is one of the standard value attribute codes defined in FlexfieldSegmentValue.

valAttrCode - the value attribute code

Returns:

the current value of the value attribute

Throws:

java.lang.IllegalArgumentException - if the given label code is undefined or unsed in any structure, or if the value attribute code is null or not associated with the given label.

setValueAttributes

void setValueAttributes(java.lang.String labelCode,
                        java.util.Map<java.lang.String,java.lang.Object> values)

Sets the value attributes.

Parameters:

labelCode - the label code

values - the values in a map where the keys are value attribute codes and the values are value attribute values. Only the value attributes associated with the given label will be set. The map does not have to contain all value attributes associated with the label. A null value-attribute value is allowed.

Throws:

java.lang.IllegalArgumentException - if the given label code or value map is null

setValueAttributes

void setValueAttributes(java.util.Map<java.lang.String,java.lang.Object> values)

Sets the standard value attributes. The codes of the standard attributes are defined as constants in FlexfieldSegmentValue.

Parameters:

values - the values in a map where the keys are value attribute codes and the values are value attribute values. Only the value attributes associated with the given label will be set. The map does not have to contain all value attributes associated with the label. A null value-attribute value is allowed.

Throws:

java.lang.IllegalArgumentException - if the given value map is null

getCodeCombinationID

java.lang.Long getCodeCombinationID()

Gets the code-combination ID.

Returns:

the code-combination ID

printAllValueAttributes

void printAllValueAttributes(java.io.PrintStream out)

Prints the information of all value attributes. The information includes the labels associated with each segment and the value attributes associated with each label. This is mainly for logging or error reporting.

Parameters:

out - the print stream