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

java.lang.Object
  oracle.apps.fnd.applcore.socialnetwork.model.pojo.nodestructure.ViewObjectNodeStructure

All Implemented Interfaces:

java.io.Serializable

public class ViewObjectNodeStructure
extends java.lang.Object
implements java.io.Serializable

The details of a View Object Social that may participate in Social Network integration via the Social Network Setups page Objects tree-table.

Since:

11.1.1.7.0

Version:

$Header: atgpf/applcore/applications/SocialNetwork/Model/src/oracle/apps/fnd/applcore/socialnetwork/model/pojo/nodestructure/ViewObjectNodeStructure.java /st_atgpf_pt-11.1.1.7.0/9 2013/04/16 19:00:33 pacross Exp $

See Also:

Serialized Form

Constructor Summary

ViewObjectNodeStructure(java.lang.String viewObjectName)
Default Constructor.

ViewObjectNodeStructure(java.lang.String description, java.lang.String enabled, java.lang.String customerEnabled)
Constructor to be used for testing.

Method Summary

void	accept(ViewObjectStructureVisitor visitor) Entry point for the visitor pattern on this node structure.
void	addUsage(SocialNetworkNode node) Register a usage of this node.
boolean	equals(java.lang.Object object)
java.lang.String	getCustomerEnabled() Gets the customer enabled OSN state of the node.
java.lang.String	getDescription() Gets the description for the node.
java.lang.String	getDescription(oracle.jbo.LocaleContext localeContext) Gets the description for the node.
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.String	getDisplayNamePlural(oracle.jbo.LocaleContext localeContext) Gets the plural display name for the node.
java.lang.String	getEnabled() Gets the enabled state of the node.
java.lang.String	getFamilyModuleId() Gets the module id for the applications family.
java.lang.String	getFamilyModuleKey() Gets the module key for the applications family.
java.lang.String	getFamilyModuleName() Gets the module name for the applications family.
java.lang.String	getOsnDefinitionName() Gets the name that can be used to register this object with Oracle Social Network.
java.lang.String	getOsnFaNavTaskflowId() Gets the id for the Navigation Taskflow Fusion Applications to use when generating the callback into Fusion Applications Link.
java.lang.String	getOsnFaNavTaskKeyList() Gets the list of key value references in the taskflow to use when generating the callback into Fusion Applications Link allowing the determination of whether a new tab is to be be created in Fusion Applications upon callback.
java.lang.String	getOsnFaNavTaskLabel() Gets the label to show in the tab in Fusion Applications when generating the callback into Fusion Applications Link.
java.lang.String	getOsnFaNavTaskParamsList() Gets the list of paramters for the taskflow to use when generating the callback into Fusion Applications Link.
java.lang.String	getOsnFaPageParamsList() Gets the list of Page Parameters Fusion Applications to use when generating the callback into Fusion Applications Link.
java.lang.String	getOsnFaViewId() Gets the id for the View in the Fusion Application to use when generating the callback into Fusion Applications Link.
java.lang.String	getOsnFaWebApp() Gets the Fusion Applications Web Application to use when generating the callback into Fusion Applications Link.
java.lang.String	getOsnImage() Gets the enabled state of the node.
java.util.List<SocialNetworkNodeAttribute>	getOsnRegisteredAttributes(boolean includeMandatory, boolean isFlattened) Provide the list of attributes of the View Object which are OSN enabled.
java.lang.String	getStatusMessage() Provide a warning status message notifyin the user why there maybe no rows sent to OSN.
boolean	getStatusMessageEnabled() Gets whether or not a status message can be available for the node.
java.util.List<java.lang.String>	getUsageNames() Gets the list of usage names for this structure.
java.util.List<SocialNetworkNode>	getUsages() Gets the list of usages of this structure.
java.lang.String	getViewObjectName() Gets the class name for the view object.
int	hashCode()
boolean	isEffectiveDated() Determine if this VO is effective dated.
boolean	isModified() Determine if any of the values/attributes in the structure have been modified.
void	loadViewObject() Load the physical definition of the view object.
void	resetStatusMessage() Reset the message and whether it is enabled.
void	saveToMDS(boolean saveOnlyModified) Save any changes to the VO or its attrbutes structure to MDS.
void	setCustomerEnabled(java.lang.String enabled) Sets the customer enabled OSN state of the node.
void	setDescription(java.lang.String description) Sets the description of the node.
void	setDisplayName(java.lang.String displayName) Sets the display name of the node.
void	setEnabled(java.lang.String enabled) Sets the enabled state of the node.
void	setFamilyModuleId(java.lang.String familyModuleId) Sets the module id for the applications family.
void	setFamilyModuleKey(java.lang.String familyModuleKey) Sets the module key for the applications family.
void	setFamilyModuleName(java.lang.String familyModuleName) Sets the module name for the applications family.
void	setOsnDefinitionName(java.lang.String osnDefinitionName) Sets the name that can be used to register this object with Oracle Social Network.
void	setOsnImage(java.lang.String osnImage) Sets the image to be used with Oracle Social Network.
void	setViewObjectName(java.lang.String viewObjectName) Sets the class name for the view object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewObjectNodeStructure

public ViewObjectNodeStructure(java.lang.String description,
                               java.lang.String enabled,
                               java.lang.String customerEnabled)

Constructor to be used for testing.

Parameters:

description - the description of the view object.

enabled - whether the view object is participating as a social network object.

customerEnabled - whether the user selected to enable for OSN.

ViewObjectNodeStructure

public ViewObjectNodeStructure(java.lang.String viewObjectName)

Default Constructor.

Parameters:

viewObjectName - the class name for the view object.

Method Detail

addUsage

public void addUsage(SocialNetworkNode node)

Register a usage of this node.

Parameters:

node - the node whose structure is this.

getUsages

public java.util.List<SocialNetworkNode> getUsages()

Gets the list of usages of this structure.

Returns:

usages.

getUsageNames

public java.util.List<java.lang.String> getUsageNames()

Gets the list of usage names for this structure.

Returns:

names of the VO usages.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the node.

Parameters:

description - the description.

getDescription

public java.lang.String getDescription()

Gets the description for the node.

Returns:

the node description.

getDescription

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

Gets the description for the node.

Parameters:

localeContext - the locale to retieve text in.

Returns:

the node description in the locale requested.

setEnabled

public void setEnabled(java.lang.String enabled)

Sets the enabled state of the node.

Parameters:

enabled - the enabled state.

getEnabled

public java.lang.String getEnabled()

Gets the enabled state of the node.

Returns:

the enabled state.

setCustomerEnabled

public void setCustomerEnabled(java.lang.String enabled)

Sets the customer enabled OSN state of the node.

Parameters:

enabled - the customer enabled OSN state.

getCustomerEnabled

public java.lang.String getCustomerEnabled()

Gets the customer enabled OSN state of the node.

Returns:

the customer enabled OSN state.

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the display name of the node.

Parameters:

displayName - the display name.

getDisplayName

public java.lang.String getDisplayName()

Gets the display name for the node.

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.

getDisplayNamePlural

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

Gets the plural display name for the node.

Parameters:

localeContext - the locale to retieve text in.

Returns:

the node plural display name for the locale.

setViewObjectName

public void setViewObjectName(java.lang.String viewObjectName)

Sets the class name for the view object.

Parameters:

viewObjectName - view object class name.

getViewObjectName

public java.lang.String getViewObjectName()

Gets the class name for the view object.

Returns:

view object class name.

setFamilyModuleKey

public void setFamilyModuleKey(java.lang.String familyModuleKey)

Sets the module key for the applications family. Note: This value can only be set once.

Parameters:

familyModuleKey - family module key.

getFamilyModuleKey

public java.lang.String getFamilyModuleKey()

Gets the module key for the applications family.

Returns:

family module key.

setFamilyModuleId

public void setFamilyModuleId(java.lang.String familyModuleId)

Sets the module id for the applications family.

Parameters:

familyModuleId - family module id.

getFamilyModuleId

public java.lang.String getFamilyModuleId()

Gets the module id for the applications family.

Returns:

family module id.

setFamilyModuleName

public void setFamilyModuleName(java.lang.String familyModuleName)

Sets the module name for the applications family.

Parameters:

familyModuleName - family module name.

getFamilyModuleName

public java.lang.String getFamilyModuleName()

Gets the module name for the applications family.

Returns:

family module name.

setOsnImage

public void setOsnImage(java.lang.String osnImage)

Sets the image to be used with Oracle Social Network.

Parameters:

osnImage - the OSN image.

getOsnImage

public java.lang.String getOsnImage()

Gets the enabled state of the node.

Returns:

the enabled state.

setOsnDefinitionName

public void setOsnDefinitionName(java.lang.String osnDefinitionName)

Sets the name that can be used to register this object with Oracle Social Network.

Parameters:

osnDefinitionName - the OSN definition name.

getOsnDefinitionName

public java.lang.String getOsnDefinitionName()

Gets the name that can be used to register this object with Oracle Social Network.

Returns:

the OSN definition name.

getOsnFaWebApp

public java.lang.String getOsnFaWebApp()

Gets the Fusion Applications Web Application to use when generating the callback into Fusion Applications Link.

Returns:

the Fusion Applications Web Application.

getOsnFaViewId

public java.lang.String getOsnFaViewId()

Gets the id for the View in the Fusion Application to use when generating the callback into Fusion Applications Link.

Returns:

the Fusion Applications View Id.

getOsnFaPageParamsList

public java.lang.String getOsnFaPageParamsList()

Gets the list of Page Parameters Fusion Applications to use when generating the callback into Fusion Applications Link.

Returns:

the Fusion Applications Page Parameters List.

getOsnFaNavTaskflowId

public java.lang.String getOsnFaNavTaskflowId()

Gets the id for the Navigation Taskflow Fusion Applications to use when generating the callback into Fusion Applications Link.

Returns:

the Fusion Applications Navigation Taskflow Id.

getOsnFaNavTaskKeyList

public java.lang.String getOsnFaNavTaskKeyList()

Gets the list of key value references in the taskflow to use when generating the callback into Fusion Applications Link allowing the determination of whether a new tab is to be be created in Fusion Applications upon callback.

Returns:

the Fusion Applications Navigation Taskflow Key List.

getOsnFaNavTaskParamsList

public java.lang.String getOsnFaNavTaskParamsList()

Gets the list of paramters for the taskflow to use when generating the callback into Fusion Applications Link.

Returns:

the Fusion Applications Navigation Taskflow Parameters.

getOsnFaNavTaskLabel

public java.lang.String getOsnFaNavTaskLabel()

Gets the label to show in the tab in Fusion Applications when generating the callback into Fusion Applications Link.

Returns:

the Fusion Applications Navigation Taskflow Label.

isEffectiveDated

public boolean isEffectiveDated()

Determine if this VO is effective dated.

Returns:

true if this VO is effective dated.

resetStatusMessage

public void resetStatusMessage()

Reset the message and whether it is enabled. Next time that getStatusMessage/getStatusMessageEnabled is called they will be re-evaluated.

getStatusMessageEnabled

public boolean getStatusMessageEnabled()

Gets whether or not a status message can be available for the node.

Returns:

true if there can be a status message.

getStatusMessage

public java.lang.String getStatusMessage()

Provide a warning status message notifyin the user why there maybe no rows sent to OSN.

Returns:

a message to show to the user or null if all is valid.

getOsnRegisteredAttributes

public java.util.List<SocialNetworkNodeAttribute> getOsnRegisteredAttributes(boolean includeMandatory,
                                                                             boolean isFlattened)

Provide the list of attributes of the View Object which are OSN enabled.

Parameters:

includeMandatory - add any mandatory attributes including "As of" attribute which is declared as mandatory iff the node is effective dated.

isFlattened - whether to traverse the children of each attribute and flatten them into this list.

Returns:

OSN enable attribute list.

loadViewObject

public void loadViewObject()

Load the physical definition of the view object.

isModified

public boolean isModified()

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

Returns:

true if any values/attributes have been modified.

saveToMDS

public void saveToMDS(boolean saveOnlyModified)

Save any changes to the VO or its attrbutes structure to MDS.

Parameters:

saveOnlyModified - only save the view objects which are modified.

accept

public void accept(ViewObjectStructureVisitor visitor)

Entry point for the visitor pattern on this node structure.

Parameters:

visitor - the visitor object to execute for this node structure.

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object