Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 7 (11.1.7)

E22562-07

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

java.lang.Object
  extended by oracle.apps.fnd.applcore.socialnetwork.model.datacontrol.SocialNetworkNodeAttribute
      extended by oracle.apps.fnd.applcore.socialnetwork.model.pojo.nodestructure.ViewObjectAttributeStructure
          extended by oracle.apps.fnd.applcore.socialnetwork.model.pojo.nodestructure.flex.OsnContextSegmentAttributeValue
All Implemented Interfaces:
java.io.Serializable

public class OsnContextSegmentAttributeValue
extends ViewObjectAttributeStructure

Context segment value which determines the custom segments which are shown. This class is a container which provides a breakdown between the context segment values and the segments which are contexutalized because of it.

Since:
11.1.1.7.0
Version:
$Header: atgpf/applcore/applications/SocialNetwork/Model/src/oracle/apps/fnd/applcore/socialnetwork/model/pojo/nodestructure/flex/OsnContextSegmentAttributeValue.java /st_atgpf_pt-11.1.1.7.0/1 2013/01/15 17:30:30 pacross Exp $
See Also:
Serialized Form

Field Summary
 
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
 
Constructor Summary
OsnContextSegmentAttributeValue(ViewObjectNodeStructure voStructure, ViewObjectAttributeStructure parent, java.lang.String contextValue, AbstractOsnFlexfieldAttributeStructure flexfield)
          Default Constructor.
 
Method Summary
 void addChildSegment(OsnFlexfieldSegmentAttributeStructure childSegment)
          Add a new child segment to this segment.
 void applyModificationsToPDefVo(oracle.jbo.server.PDefViewObject pDefVO)
          Internal Use Only.
 java.util.List<SocialNetworkNodeAttribute> getChildren()
          Get the list of child attributes that exist for this attribute as a hierarchy.
 java.lang.String getContextCode()
          Get the context segment attribute value.
 java.lang.String getContextDescription()
          Get the context value description.
 java.lang.String getContextName()
          Get the context value name.
 java.lang.String getCustomerEnabled()
          Gets the enabled state of the node as set by the customer.
 java.lang.String getDisplayName()
          Gets the display name for the node.
 java.lang.String getDisplayName(oracle.jbo.LocaleContext localeContext)
          Gets the display name for the node.
 java.lang.String getDisplayNamePlural()
          Gets the plural display name for the node.
 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 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.Boolean getSelectableForSend()
          Gets whether the attribute can be selected for sending to OSN.
 java.lang.Boolean getSensitive()
          Gets the state of the sensitive flag.
 boolean isModified()
          Determine if any of the values in the structure have been modified.
 boolean isRequired()
          Context Segment Values will never be required.
 boolean isShowableInFlattenedAttributeList()
          Whether to add this current attribute to the flattened list of attributes returned for the node.
 boolean isUserKeyAttribute()
          Context Segment Values will never be the user key attribute.
 void loadAttribute(oracle.jbo.server.AttributeDefImpl attrDef)
          Load the structure of the attribute from the definition provided.
 void loadContextSensitiveRowValues(oracle.jbo.Row segmentRow)
          load the details about the context segment attribute value (name/description) from the context segment attribute row which will be used as part of the OSN flexfield integration.
 void setContextCode(java.lang.String contextCode)
          Set the context segment attribute value.
 void setContextDescription(java.lang.String contextDescription)
          Set the context value description.
 void setContextName(java.lang.String contextValueName)
          Set the context value name.
 void setEffectiveDated(java.lang.Boolean effectiveDated)
          Determine if this attribute belongs to a VO which is effective dated.
 void setParentAttribute(ViewObjectAttributeStructure parent)
          Set the attribute node which contains (is the parent) of this attribute.
 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, getAttributeStorageName, getChangedCustomerEnabled, getCurrencyCodeAttribute, getParentAttribute, getVoStructure, hashCode, isMandatorySave, loadAttributeProperties, loadDefinition, rollbackCustomerEnabledChanges, setChangedCustomerEnabled, setCustomerEnabled, setDisplayName, setEnabled
 
Methods inherited from class oracle.apps.fnd.applcore.socialnetwork.model.datacontrol.SocialNetworkNodeAttribute
getAdditionalInformationItems, getAttributeName, getFlattenedParentage, getMandatory, getName, isAdditionalInformationAvailable, setAttributeName, setFlattenedParentage, setMandatory, setName, setSelectableForSend
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OsnContextSegmentAttributeValue

public OsnContextSegmentAttributeValue(ViewObjectNodeStructure voStructure,
                                       ViewObjectAttributeStructure parent,
                                       java.lang.String contextValue,
                                       AbstractOsnFlexfieldAttributeStructure flexfield)
Default Constructor.

Parameters:
voStructure - the view object containing this attribute.
parent - the context segment which contains this value.
contextValue - the value of the context.
flexfield - the flexfield this context sensitive attribute value is assigned to.
Method Detail

setParentAttribute

public void setParentAttribute(ViewObjectAttributeStructure parent)
Set the attribute node which contains (is the parent) of this attribute.

Overrides:
setParentAttribute in class ViewObjectAttributeStructure

loadContextSensitiveRowValues

public void loadContextSensitiveRowValues(oracle.jbo.Row segmentRow)
load the details about the context segment attribute value (name/description) from the context segment attribute row which will be used as part of the OSN flexfield integration.

Parameters:
segmentRow - a JBO row containing the attribute valeus representing the structure details.

addChildSegment

public void addChildSegment(OsnFlexfieldSegmentAttributeStructure 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 attributes. Empty list if no children.

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 attributes. Empty list if no children.

setContextCode

public void setContextCode(java.lang.String contextCode)
Set the context segment attribute value.

Parameters:
contextCode - the context value.

getContextCode

public java.lang.String getContextCode()
Get the context segment attribute value.

Returns:
the context value.

setContextName

public void setContextName(java.lang.String contextValueName)
Set the context value name.

Parameters:
contextValueName - the context value name.

getContextName

public java.lang.String getContextName()
Get the context value name.

Returns:
the context value name.

setContextDescription

public void setContextDescription(java.lang.String contextDescription)
Set the context value description.

Parameters:
contextDescription - the context value description.

getContextDescription

public java.lang.String getContextDescription()
Get the context value description.

Returns:
the context value description.

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.

getCustomerEnabled

public java.lang.String getCustomerEnabled()
Gets the enabled state of the node as set by the customer. Always True.

Overrides:
getCustomerEnabled in class ViewObjectAttributeStructure
Returns:
the enabled state.

getDisplayName

public java.lang.String getDisplayName()
Gets the display name for the node..

Overrides:
getDisplayName in class ViewObjectAttributeStructure
Returns:
the display name for the flexfield.

getDisplayNamePlural

public java.lang.String getDisplayNamePlural()
Gets the plural display name for the node..

Overrides:
getDisplayNamePlural in class ViewObjectAttributeStructure
Returns:
the node plural display name.

getDisplayName

public java.lang.String getDisplayName(oracle.jbo.LocaleContext localeContext)
Gets the display name for the node..

Overrides:
getDisplayName in class ViewObjectAttributeStructure
Parameters:
localeContext - the locale to retieve text in.
Returns:
the node display name.

getSelectableForSend

public java.lang.Boolean getSelectableForSend()
Gets whether the attribute can be selected for sending to OSN.

Overrides:
getSelectableForSend in class SocialNetworkNodeAttribute
Returns:
true if the attribute can be registered with OSN.

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:
null.

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()
Context Segment Values will never be the user key attribute.

Overrides:
isUserKeyAttribute in class ViewObjectAttributeStructure
Returns:
false.

isRequired

public boolean isRequired()
Context Segment Values will never be required.

Overrides:
isRequired in class ViewObjectAttributeStructure
Returns:
false.

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.

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.

isShowableInFlattenedAttributeList

public boolean isShowableInFlattenedAttributeList()
Whether to add this current attribute to the flattened list of attributes returned for the node..

Overrides:
isShowableInFlattenedAttributeList in class SocialNetworkNodeAttribute
Returns:
true if this attribute is to appear in the flattened list of attributes.

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..

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.

Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 7 (11.1.7)

E22562-07

Copyright © 2013 Oracle. All Rights Reserved.