oracle.apps.fnd.applcore.flex.runtime.util.common
Class SegmentLabel

java.lang.Object
  oracle.apps.fnd.applcore.flex.runtime.util.common.SegmentLabel

public abstract class SegmentLabel
extends java.lang.Object

A segment label.

Nested Class Summary

static interface	SegmentLabel.ValidationRule A validation rule associated with a segment label.
static class	SegmentLabel.ValidationRuleExpression A validation rule expression.
static class	SegmentLabel.ValidationRuleInstance An instance of a validation rule.
static interface	SegmentLabel.ValueAttribute A value attribute of a segment label.

Constructor Summary

protected

SegmentLabel(java.lang.String code, java.lang.String name) Constructs a segment label.

Method Summary

java.lang.String	getCode() Gets the code of this label.
abstract java.lang.String	getDescription() Gets the description of this label.
java.lang.String	getName() Gets the name of this label.
abstract java.util.Map<java.lang.String,java.lang.String>	getTranslatedNames() Gets translated names for multiple languages.
abstract java.util.List<SegmentLabel.ValidationRule>	getValidationRules() Gets the list of validation rules.
abstract java.util.List<SegmentLabel.ValueAttribute>	getValueAttributes() Gets the list of value attributes.
abstract boolean	isGlobal() Returns true if this label is assigned to every segment.
abstract boolean	isRequired() Returns true if this label must be assigned.
abstract boolean	isUnique() Returns true if this label should be assigned to only one segment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SegmentLabel

protected SegmentLabel(java.lang.String code,
                       java.lang.String name)

Constructs a segment label.

Parameters:

code - the code

name - the name

Throws:

java.lang.IllegalArgumentException - if the given code or name is null

Method Detail

getCode

public final java.lang.String getCode()

Gets the code of this label.

Returns:

the code of this label

getName

public final java.lang.String getName()

Gets the name of this label.

Returns:

the name of this label

getTranslatedNames

public abstract java.util.Map<java.lang.String,java.lang.String> getTranslatedNames()

Gets translated names for multiple languages. The keys are language codes and the values are names in those languages.

Returns:

the translated names for multiple languages; an empty map if no translated names are available

getDescription

public abstract java.lang.String getDescription()

Gets the description of this label.

Returns:

the description of this label

isGlobal

public abstract boolean isGlobal()

Returns true if this label is assigned to every segment.

Returns:

true if this label is assigned to every segment

isRequired

public abstract boolean isRequired()

Returns true if this label must be assigned.

Returns:

true if this label must be assigned

isUnique

public abstract boolean isUnique()

Returns true if this label should be assigned to only one segment.

Returns:

true if this label should be assigned to only one segment

getValueAttributes

public abstract java.util.List<SegmentLabel.ValueAttribute> getValueAttributes()

Gets the list of value attributes.

Returns:

the list of value attributes; an empty list if there's no value attributes

getValidationRules

public abstract java.util.List<SegmentLabel.ValidationRule> getValidationRules()

Gets the list of validation rules.

Returns:

the list of validation rules; an empty list if there's no validation rules