oracle.apps.fnd.applcore.socialnetwork.model.pojo.nodestructure
Class ViewObjectAttributeStructure

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AbstractOsnFlexfieldAttributeStructure, AsOfNodeAttribute, OsnContextSegmentAttributeValue, OsnFlexfieldSegmentAttributeStructure

public class ViewObjectAttributeStructure
extends SocialNetworkNodeAttribute
implements java.io.Serializable

Attribute definition for the selected social network node.

Since:

11.1.1.7.0

Version:

$Header: atgpf/applcore/applications/SocialNetwork/Model/src/oracle/apps/fnd/applcore/socialnetwork/model/pojo/nodestructure/ViewObjectAttributeStructure.java /st_atgpf_pt-11.1.1.7.0/5 2013/04/18 16:40:18 pacross Exp $

See Also:

Serialized Form

Field Summary

protected oracle.jbo.server.AttributeDefImpl	_attrDef
static java.lang.String	ATTR_OSN_ENABLED
protected static java.lang.String	ATTR_OSN_ENABLED_CUST
protected static java.lang.String	ATTRIBUTE_OSN_FALSE
protected static java.lang.String	ATTRIBUTE_OSN_TRUE
protected static java.lang.String	ATTRIBUTE_PROPERTY_EXTRACT_SEPARATOR
protected static java.lang.String	ATTRIBUTE_PROPERTY_SEPARATOR

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

ENABLED_FALSE, ENABLED_TRUE

Constructor Summary

ViewObjectAttributeStructure(ViewObjectNodeStructure voStructure)
Default Constructor.

Method Summary

void	applyCustomerEnabledChanges() Commit any changes made via setChangedCustomerEnabled to be applied for use from getCustomerEnabled.
void	applyModificationsToPDefVo(oracle.jbo.server.PDefViewObject pDefVO) Internal Use Only.
boolean	equals(java.lang.Object object)
oracle.jbo.server.AttributeDefImpl	getAttributeDef(java.lang.String childAttributeName) In scenarios where this attribute has children, load the definition for the child attribute node.
java.lang.String	getAttributeStorageName() Internal Use Only.
java.lang.Boolean	getChangedCustomerEnabled() Gets the un-applied enabled state of the node as set by the customer.
java.lang.String	getCurrencyCodeAttribute() The name of the attribute to use for the currency code.
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.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.
ViewObjectAttributeStructure	getParentAttribute() Retrieve the attribute node which contains (is the parent) of this attribute.
int	getPrecision() Gets the precision definition for the attribute.
int	getScale() Gets the scale definition for the attribute.
java.lang.Boolean	getSensitive() Gets the state of the sensitive flag.
protected ViewObjectNodeStructure	getVoStructure() Get the View Object Node Structure for this attribute.
int	hashCode()
boolean	isMandatorySave() If a save occurs then this attribute must be saved.
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() Gets whether the fusion applications developer wants this attribute as the display name for the View Object instance.
void	loadAttribute(oracle.jbo.server.AttributeDefImpl attrDef) Load the structure of the attribute from the definition provided.
protected void	loadAttributeProperties(oracle.jbo.server.AttributeDefImpl attrDef, oracle.jbo.LocaleContext localeContext, SnPropertyCollection properties) Load the _properties collection based upon the attributes from attrDef.
protected oracle.jbo.server.AttributeDefImpl	loadDefinition() Load a personalized copy of the attribute definition.
void	rollbackCustomerEnabledChanges() Rollback any changes made via setChangedCustomerEnabled so the value returned from getCustomerEnabled will remain unchanged.
void	setChangedCustomerEnabled(java.lang.Boolean enabled) Sets the un-applied enabled state of the node as set by the customer.
void	setCustomerEnabled(java.lang.String enabled) Sets the enabled state of the node as set by the customer.
void	setDisplayName(java.lang.String displayName) Sets the display name of the node.
void	setEffectiveDated(java.lang.Boolean effectiveDated) Determine if this attribute belongs to a VO which is effective dated.
void	setEnabled(java.lang.String enabled) Sets the enabled state of the node.
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.datacontrol.SocialNetworkNodeAttribute

getAdditionalInformationItems, getAttributeName, getChildren, getFlattenedChildren, getFlattenedParentage, getMandatory, getName, getSelectableForSend, isAdditionalInformationAvailable, isShowableInFlattenedAttributeList, setAttributeName, setFlattenedParentage, setMandatory, setName, setSelectableForSend

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_PROPERTY_SEPARATOR

protected static final java.lang.String ATTRIBUTE_PROPERTY_SEPARATOR

See Also:

Constant Field Values

ATTRIBUTE_PROPERTY_EXTRACT_SEPARATOR

protected static final java.lang.String ATTRIBUTE_PROPERTY_EXTRACT_SEPARATOR

See Also:

Constant Field Values

ATTRIBUTE_OSN_TRUE

protected static final java.lang.String ATTRIBUTE_OSN_TRUE

See Also:

Constant Field Values

ATTRIBUTE_OSN_FALSE

protected static final java.lang.String ATTRIBUTE_OSN_FALSE

See Also:

Constant Field Values

ATTR_OSN_ENABLED

public static final java.lang.String ATTR_OSN_ENABLED

See Also:

Constant Field Values

ATTR_OSN_ENABLED_CUST

protected static final java.lang.String ATTR_OSN_ENABLED_CUST

See Also:

Constant Field Values

_attrDef

protected transient oracle.jbo.server.AttributeDefImpl _attrDef

Constructor Detail

ViewObjectAttributeStructure

public ViewObjectAttributeStructure(ViewObjectNodeStructure voStructure)

Default Constructor.

Parameters:

voStructure - the view object containing this attribute.

Method Detail

getVoStructure

protected ViewObjectNodeStructure getVoStructure()

Get the View Object Node Structure for this attribute.

Returns:

the View Object Node Structure.

getAttributeDef

public oracle.jbo.server.AttributeDefImpl getAttributeDef(java.lang.String childAttributeName)

In scenarios where this attribute has children, load the definition for the child attribute node.

Parameters:

childAttributeName - the name of a child attribute.

Returns:

always null for a standard attribute.

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.

setEnabled

public void setEnabled(java.lang.String enabled)

Sets the enabled state of the node.

Specified by:

setEnabled in class SocialNetworkNodeAttribute

Parameters:

enabled - the enabled state.

getEnabled

public java.lang.String getEnabled()

Gets the enabled state of the node.

Specified by:

getEnabled in class SocialNetworkNodeAttribute

Returns:

the enabled state.

setCustomerEnabled

public void setCustomerEnabled(java.lang.String enabled)

Sets the enabled state of the node as set by the customer.

Specified by:

setCustomerEnabled in class SocialNetworkNodeAttribute

Parameters:

enabled - the enabled state.

getCustomerEnabled

public java.lang.String getCustomerEnabled()

Gets the enabled state of the node as set by the customer.

Specified by:

getCustomerEnabled in class SocialNetworkNodeAttribute

Returns:

the enabled state.

setChangedCustomerEnabled

public void setChangedCustomerEnabled(java.lang.Boolean enabled)

Sets the un-applied enabled state of the node as set by the customer. Note: calling getCustomerEnabled will not see any change made by this method.

Specified by:

setChangedCustomerEnabled in class SocialNetworkNodeAttribute

Parameters:

enabled - the enabled state.

getChangedCustomerEnabled

public java.lang.Boolean getChangedCustomerEnabled()

Gets the un-applied enabled state of the node as set by the customer. If no calls to setChangedCustomerEnabledBoolean have been made then the boolean equivalent of getCustomerEnabled will be returned.

Specified by:

getChangedCustomerEnabled in class SocialNetworkNodeAttribute

Returns:

the un-applied enabled state.

applyCustomerEnabledChanges

public void applyCustomerEnabledChanges()

Commit any changes made via setChangedCustomerEnabled to be applied for use from getCustomerEnabled.

Specified by:

applyCustomerEnabledChanges in class SocialNetworkNodeAttribute

rollbackCustomerEnabledChanges

public void rollbackCustomerEnabledChanges()

Rollback any changes made via setChangedCustomerEnabled so the value returned from getCustomerEnabled will remain unchanged.

Specified by:

rollbackCustomerEnabledChanges in class SocialNetworkNodeAttribute

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the display name of the node.

Specified by:

setDisplayName in class SocialNetworkNodeAttribute

Parameters:

displayName - the display name.

getDisplayName

public java.lang.String getDisplayName()

Gets the display name for the node.

Specified by:

getDisplayName in class SocialNetworkNodeAttribute

Returns:

the node display name.

getDisplayName

public java.lang.String getDisplayName(oracle.jbo.LocaleContext localeContext)

Gets the display name for the node.

Parameters:

localeContext - the locale to retieve text in.

Returns:

the node display name.

getDisplayNamePlural

public java.lang.String getDisplayNamePlural()

Gets the plural display name for the node.

Returns:

the node plural display name.

setSensitive

public void setSensitive(java.lang.Boolean sensitive)

Sets the state of the sensitive flag.

Specified by:

setSensitive in class SocialNetworkNodeAttribute

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.

Specified by:

getSensitive in class SocialNetworkNodeAttribute

Returns:

the sensitive flag value.

getJavaType

public java.lang.String getJavaType()

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

Returns:

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

getGadgetType

public java.lang.String getGadgetType()

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

Returns:

the gadget type.

isUserKeyAttribute

public boolean isUserKeyAttribute()

Gets whether the fusion applications developer wants this attribute as the display name for the View Object instance.

Returns:

true if attribute is the user key attribute.

isRequired

public boolean isRequired()

Gets the mandatory flag for the BC4J attribute definition.

Returns:

BC4J attribute mandatory flag.

getPrecision

public int getPrecision()

Gets the precision definition for the attribute.

Returns:

attribute precision.

getScale

public int getScale()

Gets the scale definition for the attribute.

Returns:

attribute scale.

isModified

public boolean isModified()

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

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.

Specified by:

getEffectiveDated in class SocialNetworkNodeAttribute

Returns:

true if this attribute is effective dated.

setEffectiveDated

public void setEffectiveDated(java.lang.Boolean effectiveDated)

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

Specified by:

setEffectiveDated in class SocialNetworkNodeAttribute

Parameters:

effectiveDated - whether this attribute is effective dated.

getCurrencyCodeAttribute

public java.lang.String getCurrencyCodeAttribute()

The name of the attribute to use for the currency code.

Returns:

the currency code attribute type.

setParentAttribute

public void setParentAttribute(ViewObjectAttributeStructure parent)

Set the attribute node which contains (is the parent) of this attribute.

getParentAttribute

public ViewObjectAttributeStructure getParentAttribute()

Retrieve the attribute node which contains (is the parent) of this attribute.

Returns:

the parent attribute or null if there is no parent.

isMandatorySave

public boolean isMandatorySave()

If a save occurs then this attribute must be saved.

Returns:

default is false.

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.

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.

Specified by:

getAttributeStorageName in class SocialNetworkNodeAttribute

Returns:

the unique attribute name.

getFullDisplayName

public java.lang.String getFullDisplayName(boolean shortened)

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

Parameters:

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

Returns:

the full display name of the attribute.

loadDefinition

protected oracle.jbo.server.AttributeDefImpl loadDefinition()

Load a personalized copy of the attribute definition.

Returns:

the attribute definition.

loadAttribute

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

Load the structure of the attribute from the definition provided.

Parameters:

attrDef - the definition of the attribute.

loadAttributeProperties

protected void loadAttributeProperties(oracle.jbo.server.AttributeDefImpl attrDef,
                                       oracle.jbo.LocaleContext localeContext,
                                       SnPropertyCollection properties)

Load the _properties collection based upon the attributes from attrDef.

Parameters:

attrDef - the attribute definition.

localeContext - the locale context to get any translations for.

properties - the collection where to put any properties in.

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class SocialNetworkNodeAttribute

hashCode

public int hashCode()

Overrides:

hashCode in class SocialNetworkNodeAttribute