oracle.apps.fnd.applcore.socialnetwork.model.pojo.nodestructure.flex
Class OsnFlexfieldSegmentAttributeStructure

java.lang.Object
  oracle.apps.fnd.applcore.socialnetwork.model.datacontrol.SocialNetworkNodeAttribute
      oracle.apps.fnd.applcore.socialnetwork.model.pojo.nodestructure.ViewObjectAttributeStructure
          oracle.apps.fnd.applcore.socialnetwork.model.pojo.nodestructure.flex.OsnFlexfieldSegmentAttributeStructure

All Implemented Interfaces:

java.io.Serializable

public class OsnFlexfieldSegmentAttributeStructure
extends ViewObjectAttributeStructure

Structure of an attribute to be used in OSN integration that represents a segment within a flexfield.

Since:

11.1.1.7.0

Version:

$Header: atgpf/applcore/applications/SocialNetwork/Model/src/oracle/apps/fnd/applcore/socialnetwork/model/pojo/nodestructure/flex/OsnFlexfieldSegmentAttributeStructure.java /st_atgpf_pt-11.1.1.7.0/1 2013/01/15 17:30:31 pacross Exp $

See Also:

Serialized Form

Field Summary

static byte	SEGMENT_CONTEXT Whether the segment is a Flexfield Context Segment.
static byte	SEGMENT_CONTEXT_SENSITIVE Whether the segment is a Flexfield Context Sensitive Segment.
static byte	SEGMENT_GLOBAL Whether the segment is a Flexfield Global Segment.

Fields inherited from class oracle.apps.fnd.applcore.socialnetwork.model.pojo.nodestructure.ViewObjectAttributeStructure

_attrDef, ATTR_OSN_ENABLED, ATTR_OSN_ENABLED_CUST, ATTRIBUTE_OSN_FALSE, ATTRIBUTE_OSN_TRUE, ATTRIBUTE_PROPERTY_EXTRACT_SEPARATOR, ATTRIBUTE_PROPERTY_SEPARATOR

Fields inherited from class oracle.apps.fnd.applcore.socialnetwork.model.datacontrol.SocialNetworkNodeAttribute

ENABLED_FALSE, ENABLED_TRUE

Method Summary

void	addChildSegment(ViewObjectAttributeStructure childSegment) Add a new child segment to this segment.
void	applyModificationsToPDefVo(oracle.jbo.server.PDefViewObject pDefVO) Internal Use Only.
static OsnFlexfieldSegmentAttributeStructure	createContextSegment(ViewObjectNodeStructure voStructure, oracle.jbo.server.AttributeDefImpl segmentAttribute, ViewObjectAttributeStructure parent, AbstractOsnFlexfieldAttributeStructure flexfield) Create a new FlexfieldSegmentAttributeStructure whose type is Context and load all of the details about the segment from the segment row attributes.
static OsnFlexfieldSegmentAttributeStructure	createContextSensitiveSegment(ViewObjectNodeStructure voStructure, oracle.jbo.server.AttributeDefImpl segmentAttribute, java.lang.String contextCode, ViewObjectAttributeStructure parent, AbstractOsnFlexfieldAttributeStructure flexfield) Create a new FlexfieldSegmentAttributeStructure whose type is Context Sensitive and load all of the details about the segment from the segment row attributes.
static OsnFlexfieldSegmentAttributeStructure	createGlobalSegment(ViewObjectNodeStructure voStructure, oracle.jbo.server.AttributeDefImpl segmentAttribute, ViewObjectAttributeStructure parent, AbstractOsnFlexfieldAttributeStructure flexfield) Create a new FlexfieldSegmentAttributeStructure whose type is Global and load all of the details about the segment from the segment row attributes.
static java.lang.String	extractAttributeName(java.lang.String attributeStorageName) Given an attribute storage name that was generated from getAttributeStorageName(), extract the name that would be returned from getName().
java.util.List<SocialNetworkEnabledItem>	getAdditionalInformationItems() Retrieve the list of label-value pairs of additional information that can be shown for an attribute.
java.lang.String	getAttributeName() Gets the name of the attribute that this structure is referred to in the VO..
java.lang.String	getAttributeStorageName() Internal Use Only.
java.util.List<SocialNetworkNodeAttribute>	getChildren() Get the list of child attributes that exist for this attribute as a hierarchy.
java.lang.Boolean	getEffectiveDated() Determine if this attribute belongs to a VO which is effective dated.
java.lang.String	getEnabled() Gets the enabled state of the node.
java.lang.String	getFieldName() Get the name to be used when generating the field definition.
java.util.List<SocialNetworkNodeAttribute>	getFlattenedChildren(boolean includeMandatory) Get the list of child attributes that exist for this attribute as a flattened list.
java.lang.String	getFlattenedParentage() Gets a flattened representation of the parents of this attribute..
AbstractOsnFlexfieldAttributeStructure	getFlexfield() Get the flexfield structure associated with this segment.
java.lang.String	getFullDisplayName(boolean shortened) Get the full display name of this attribute including all parent display names/
java.lang.String	getGadgetType() The type of gadget that the fusion applications developer defined the attribute as.
java.lang.String	getJavaType() The Java type that the attribute will return its value as at runtime.
int	getPrecision() Gets the precision definition for the attribute.
int	getScale() Gets the scale definition for the attribute.
java.lang.String	getSegmentCode() Get the code identifier of the segment.
java.lang.String	getSegmentContextCode() Get the segment code of the context segment which this attribute is sensitive to.
byte	getSegmentType() Get the type of segment this attribute is.
java.lang.Boolean	getSensitive() Gets the state of the sensitive flag.
boolean	isAdditionalInformationAvailable() Determine if there is additional information that can be shown about the attribute.
boolean	isModified() Determine if any of the values in the structure have been modified.
boolean	isRequired() Gets the mandatory flag for the BC4J attribute definition.
boolean	isUserKeyAttribute() Segments will never be the user key attribute.
void	loadAttribute(oracle.jbo.server.AttributeDefImpl attrDef) Load the structure of the attribute from the definition provided.
protected oracle.jbo.server.AttributeDefImpl	loadDefinition() Load the attribute definition.
protected oracle.jbo.server.AttributeDefImpl	loadDisplayDefinition() Loads the attribute definition to use when there is a display attribute defined.
void	setAttributeName(java.lang.String attributeName) Sets the name of the attribute that this structure is referred to in the VO..
void	setEffectiveDated(java.lang.Boolean effectiveDated) Determine if this attribute belongs to a VO which is effective dated.
void	setSegmentContextCode(java.lang.String segmentContextCode) Set the segment code of the context segment which this attribute is sensitive to.
void	setSensitive(java.lang.Boolean sensitive) Sets the state of the sensitive flag.

Methods inherited from class oracle.apps.fnd.applcore.socialnetwork.model.pojo.nodestructure.ViewObjectAttributeStructure

applyCustomerEnabledChanges, equals, getAttributeDef, getChangedCustomerEnabled, getCurrencyCodeAttribute, getCustomerEnabled, getDisplayName, getDisplayName, getDisplayNamePlural, getParentAttribute, getVoStructure, hashCode, isMandatorySave, loadAttributeProperties, rollbackCustomerEnabledChanges, setChangedCustomerEnabled, setCustomerEnabled, setDisplayName, setEnabled, setParentAttribute

Methods inherited from class oracle.apps.fnd.applcore.socialnetwork.model.datacontrol.SocialNetworkNodeAttribute

getMandatory, getName, getSelectableForSend, isShowableInFlattenedAttributeList, setFlattenedParentage, setMandatory, setName, setSelectableForSend

Methods inherited from class java.lang.Object

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

Field Detail

SEGMENT_GLOBAL

public static final byte SEGMENT_GLOBAL

Whether the segment is a Flexfield Global Segment.

See Also:

Constant Field Values

SEGMENT_CONTEXT

public static final byte SEGMENT_CONTEXT

Whether the segment is a Flexfield Context Segment.

See Also:

Constant Field Values

SEGMENT_CONTEXT_SENSITIVE

public static final byte SEGMENT_CONTEXT_SENSITIVE

Whether the segment is a Flexfield Context Sensitive Segment.

See Also:

Constant Field Values

Method Detail

createGlobalSegment

public static OsnFlexfieldSegmentAttributeStructure createGlobalSegment(ViewObjectNodeStructure voStructure,
                                                                        oracle.jbo.server.AttributeDefImpl segmentAttribute,
                                                                        ViewObjectAttributeStructure parent,
                                                                        AbstractOsnFlexfieldAttributeStructure flexfield)

Create a new FlexfieldSegmentAttributeStructure whose type is Global and load all of the details about the segment from the segment row attributes.

Parameters:

voStructure - the View Object which the flexfield belongs to.

segmentAttribute - the attribute definition of the segment within its VO.

parent - the parent attribute of this segment.

flexfield - the flexfield this segment is contained within.

Returns:

the created global segment.

createContextSegment

public static OsnFlexfieldSegmentAttributeStructure createContextSegment(ViewObjectNodeStructure voStructure,
                                                                         oracle.jbo.server.AttributeDefImpl segmentAttribute,
                                                                         ViewObjectAttributeStructure parent,
                                                                         AbstractOsnFlexfieldAttributeStructure flexfield)

Create a new FlexfieldSegmentAttributeStructure whose type is Context and load all of the details about the segment from the segment row attributes.

Parameters:

voStructure - the View Object which the flexfield belongs to.

segmentAttribute - the attribute definition of the segment within its VO.

parent - the parent attribute of this segment.

flexfield - the flexfield this segment is contained within.

Returns:

the created context segment.

createContextSensitiveSegment

public static OsnFlexfieldSegmentAttributeStructure createContextSensitiveSegment(ViewObjectNodeStructure voStructure,
                                                                                  oracle.jbo.server.AttributeDefImpl segmentAttribute,
                                                                                  java.lang.String contextCode,
                                                                                  ViewObjectAttributeStructure parent,
                                                                                  AbstractOsnFlexfieldAttributeStructure flexfield)

Create a new FlexfieldSegmentAttributeStructure whose type is Context Sensitive and load all of the details about the segment from the segment row attributes.

Parameters:

voStructure - the View Object which the flexfield belongs to. * @param segmentAttribute the attribute definition of the segment within its VO.

parent - the parent attribute of this segment.

flexfield - the flexfield this segment is contained within.

Returns:

the created context sensitive segment.

loadDefinition

protected oracle.jbo.server.AttributeDefImpl loadDefinition()

Load the attribute definition.

Overrides:

loadDefinition in class ViewObjectAttributeStructure

Returns:

the attribute definition.

loadDisplayDefinition

protected oracle.jbo.server.AttributeDefImpl loadDisplayDefinition()

Loads the attribute definition to use when there is a display attribute defined. If there is a display attribute it will be used otherwise the loadDefintiion() result.

Returns:

the attribute definition used to display.

setAttributeName

public void setAttributeName(java.lang.String attributeName)

Sets the name of the attribute that this structure is referred to in the VO..

Overrides:

setAttributeName in class SocialNetworkNodeAttribute

Parameters:

attributeName - the VO attribute name.

getAttributeName

public java.lang.String getAttributeName()

Gets the name of the attribute that this structure is referred to in the VO..

Overrides:

getAttributeName in class SocialNetworkNodeAttribute

Returns:

the VO attribute name.

getSegmentType

public byte getSegmentType()

Get the type of segment this attribute is.

Returns:

One of: SEGMENT_GLOBAL, SEGMENT_CONTEXT, SEGMENT_CONTEXT_SENSITIVE.

getFlexfield

public AbstractOsnFlexfieldAttributeStructure getFlexfield()

Get the flexfield structure associated with this segment.

Returns:

getSegmentCode

public java.lang.String getSegmentCode()

Get the code identifier of the segment.

Returns:

the segment code.

setSegmentContextCode

public void setSegmentContextCode(java.lang.String segmentContextCode)

Set the segment code of the context segment which this attribute is sensitive to.

Parameters:

segmentContextCode - the context that this segment is sensitive to.

getSegmentContextCode

public java.lang.String getSegmentContextCode()

Get the segment code of the context segment which this attribute is sensitive to.

Returns:

the context that this segment is sensitive to.

addChildSegment

public void addChildSegment(ViewObjectAttributeStructure childSegment)

Add a new child segment to this segment.

Parameters:

childSegment - the child of this segment.

getChildren

public java.util.List<SocialNetworkNodeAttribute> getChildren()

Get the list of child attributes that exist for this attribute as a hierarchy..

Overrides:

getChildren in class SocialNetworkNodeAttribute

Returns:

the list of child segment attributes for this flexfield. Empty list if no child segments exist.

getFlattenedChildren

public java.util.List<SocialNetworkNodeAttribute> getFlattenedChildren(boolean includeMandatory)

Get the list of child attributes that exist for this attribute as a flattened list..

Overrides:

getFlattenedChildren in class SocialNetworkNodeAttribute

Parameters:

includeMandatory - whether to only return non-mandatory attributes or all attributes.

Returns:

the list of child segment attributes for this flexfield. Empty list if no child segments exist.

getFieldName

public java.lang.String getFieldName()

Get the name to be used when generating the field definition. This will take into consideration the override property..

Overrides:

getFieldName in class ViewObjectAttributeStructure

getEnabled

public java.lang.String getEnabled()

Gets the enabled state of the node. Always True.

Overrides:

getEnabled in class ViewObjectAttributeStructure

Returns:

the enabled state.

getFullDisplayName

public java.lang.String getFullDisplayName(boolean shortened)

Get the full display name of this attribute including all parent display names/.

Overrides:

getFullDisplayName in class ViewObjectAttributeStructure

Parameters:

shortened - whether to show a shortened version of the display name.

Returns:

the full display name of the attribute.

getFlattenedParentage

public java.lang.String getFlattenedParentage()

Gets a flattened representation of the parents of this attribute..

Overrides:

getFlattenedParentage in class SocialNetworkNodeAttribute

Returns:

the flattened attribute node parent display names.

setSensitive

public void setSensitive(java.lang.Boolean sensitive)

Sets the state of the sensitive flag.

Overrides:

setSensitive in class ViewObjectAttributeStructure

Parameters:

sensitive - the sensitive flag value.

getSensitive

public java.lang.Boolean getSensitive()

Gets the state of the sensitive flag. Note if the VO is date effective, all attributes will be marked as sensitive by default. Always False.

Overrides:

getSensitive in class ViewObjectAttributeStructure

Returns:

the sensitive flag value.

getJavaType

public java.lang.String getJavaType()

The Java type that the attribute will return its value as at runtime.

Overrides:

getJavaType in class ViewObjectAttributeStructure

Returns:

the attributes Java type. Null will be returned if the Java type can not be determined.

getPrecision

public int getPrecision()

Gets the precision definition for the attribute.

Overrides:

getPrecision in class ViewObjectAttributeStructure

Returns:

attribute precision.

getScale

public int getScale()

Gets the scale definition for the attribute.

Overrides:

getScale in class ViewObjectAttributeStructure

Returns:

attribute scale.

getGadgetType

public java.lang.String getGadgetType()

The type of gadget that the fusion applications developer defined the attribute as..

Overrides:

getGadgetType in class ViewObjectAttributeStructure

Returns:

null.

isUserKeyAttribute

public boolean isUserKeyAttribute()

Segments will never be the user key attribute.

Overrides:

isUserKeyAttribute in class ViewObjectAttributeStructure

Returns:

false.

isRequired

public boolean isRequired()

Gets the mandatory flag for the BC4J attribute definition..

Overrides:

isRequired in class ViewObjectAttributeStructure

Returns:

BC4J attribute mandatory flag.

isModified

public boolean isModified()

Determine if any of the values in the structure have been modified..

Overrides:

isModified in class ViewObjectAttributeStructure

Returns:

true if any values have been modified.

getEffectiveDated

public java.lang.Boolean getEffectiveDated()

Determine if this attribute belongs to a VO which is effective dated..

Overrides:

getEffectiveDated in class ViewObjectAttributeStructure

Returns:

false for flexfields.

setEffectiveDated

public void setEffectiveDated(java.lang.Boolean effectiveDated)

Determine if this attribute belongs to a VO which is effective dated..

Overrides:

setEffectiveDated in class ViewObjectAttributeStructure

Parameters:

effectiveDated - whether this attribute is effective dated.

loadAttribute

public void loadAttribute(oracle.jbo.server.AttributeDefImpl attrDef)

Load the structure of the attribute from the definition provided..

Overrides:

loadAttribute in class ViewObjectAttributeStructure

Parameters:

attrDef - the definition of the attribute.

applyModificationsToPDefVo

public void applyModificationsToPDefVo(oracle.jbo.server.PDefViewObject pDefVO)

Internal Use Only. This method should only be called from ViewObjectNodeStructure. Applies the changes made to this attribute to the persdef View Object supplied.

Overrides:

applyModificationsToPDefVo in class ViewObjectAttributeStructure

Parameters:

pDefVO - the personalization VO representation of the VO that contains this attribute..

getAttributeStorageName

public java.lang.String getAttributeStorageName()

Internal Use Only. A unique attribute name that can be used when storing information for the attribute.

Overrides:

getAttributeStorageName in class ViewObjectAttributeStructure

Returns:

the unique attribute name.

extractAttributeName

public static java.lang.String extractAttributeName(java.lang.String attributeStorageName)

Given an attribute storage name that was generated from getAttributeStorageName(), extract the name that would be returned from getName().

Parameters:

attributeStorageName - an attribute storage name from getAttributeStorageName().

isAdditionalInformationAvailable

public boolean isAdditionalInformationAvailable()

Determine if there is additional information that can be shown about the attribute.

Overrides:

isAdditionalInformationAvailable in class SocialNetworkNodeAttribute

Returns:

true if a call to getAdditionalInformationItems will return data.

getAdditionalInformationItems

public java.util.List<SocialNetworkEnabledItem> getAdditionalInformationItems()

Retrieve the list of label-value pairs of additional information that can be shown for an attribute.

Overrides:

getAdditionalInformationItems in class SocialNetworkNodeAttribute

Returns:

the list of information to show.