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

E22562-07

oracle.apps.fnd.applcore.socialnetwork.model.pojo.nodeusage
Class ViewObjectUsageNode

java.lang.Object
  extended by oracle.apps.fnd.applcore.socialnetwork.model.datacontrol.SocialNetworkNode
      extended by oracle.apps.fnd.applcore.socialnetwork.model.pojo.nodeusage.ViewObjectUsageNode
All Implemented Interfaces:
java.io.Serializable, XmlOsnParsableNode

public class ViewObjectUsageNode
extends SocialNetworkNode
implements XmlOsnParsableNode, 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/nodeusage/ViewObjectUsageNode.java /st_atgpf_pt-11.1.1.7.0/4 2013/03/03 11:30:03 pacross Exp $
See Also:
Serialized Form

Field Summary
static java.lang.String XML_LOCAL_VIEW_LINK_USAGE
           
static java.lang.String XML_LOCAL_VIEW_USAGE
           
 
Fields inherited from class oracle.apps.fnd.applcore.socialnetwork.model.datacontrol.SocialNetworkNode
_key, ENABLED_AUTOMATIC, ENABLED_MANUAL, ENABLED_NO
 
Fields inherited from interface oracle.apps.fnd.applcore.socialnetwork.model.pojo.XmlOsnParsableNode
ATTRIBUTE_NAME, XML_NAMESPACE
 
Constructor Summary
ViewObjectUsageNode(java.lang.String name, SocialNetworkNode parent, ViewObjectNodeStructure voStructure)
          Default Constructor.
ViewObjectUsageNode(java.lang.String name, java.lang.String description, java.lang.String customerEnabled)
          Constructor for testing.
 
Method Summary
 boolean equals(java.lang.Object object)
          
static SocialNetworkNode fromXML(org.w3c.dom.Element xmlElement, SocialNetworkNode parent, SocialNetworkStructureStorage storage, java.lang.String appKey, java.lang.String appName, java.lang.String appModuleId)
          Parses the view object element node provided, validates it is a ViewUsage xml node and requests the parsing of its nested VO child nodes.
 java.util.List<SocialNetworkNodeAttribute> getAttributes(boolean includeMandatory)
          Provide the list of attributes of the View 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 getDisplayName()
          Gets the display name for the node.
 java.lang.String getEnabled()
          Gets the enabled state of the node.
 java.lang.String getName()
          Gets the name of the node.
 java.util.List<SocialNetworkNodeAttribute> getOsnEnabledAttributes(boolean includeMandatory)
          Provide the list of attributes of the View Object which are OSN enabled.
 java.lang.String getStatusMessage()
          Gets the status message for the node.
 boolean getStatusMessageEnabled()
          Gets whether or not a status message can be available for the node.
 ViewLinkUsageNode getViewLink()
          Gets the view link to the parent VO.
 int hashCode()
          
 boolean isViewObjectNode()
          Provide whether this node represents a view object.
 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 setName(java.lang.String name)
          Sets the name of the node.
 void setStatusMessage(java.lang.String statusMessage)
          Sets the status message for the node.
 void setStatusMessageEnabled(boolean statusMessageEnabled)
          Sets whether or not a status message can be available for the node.
 void setViewLink(ViewLinkUsageNode viewLink)
          Sets the view link to the parent VO.
 
Methods inherited from class oracle.apps.fnd.applcore.socialnetwork.model.datacontrol.SocialNetworkNode
addChild, getChildren, getKey, getParent, setParent
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

XML_LOCAL_VIEW_USAGE

public static final java.lang.String XML_LOCAL_VIEW_USAGE
See Also:
Constant Field Values

XML_LOCAL_VIEW_LINK_USAGE

public static final java.lang.String XML_LOCAL_VIEW_LINK_USAGE
See Also:
Constant Field Values
Constructor Detail

ViewObjectUsageNode

public ViewObjectUsageNode(java.lang.String name,
                           java.lang.String description,
                           java.lang.String customerEnabled)
Constructor for testing.

Parameters:
name - the view object name.
description - the description of the view object.
customerEnabled - whether the view object is participating as a social network object.

ViewObjectUsageNode

public ViewObjectUsageNode(java.lang.String name,
                           SocialNetworkNode parent,
                           ViewObjectNodeStructure voStructure)
Default Constructor.

Parameters:
name - the view object name.
parent - the parent node of this view object.
Method Detail

setName

public void setName(java.lang.String name)
Sets the name of the node.

Specified by:
setName in class SocialNetworkNode
Parameters:
name - the node name.

getName

public java.lang.String getName()
Gets the name of the node.

Specified by:
getName in class SocialNetworkNode
Returns:
the name.

setDescription

public void setDescription(java.lang.String description)
Sets the description of the node.

Specified by:
setDescription in class SocialNetworkNode
Parameters:
description - the description.

getDescription

public java.lang.String getDescription()
Gets the description for the node.

Specified by:
getDescription in class SocialNetworkNode
Returns:
the node description.

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.

Overrides:
getEnabled in class SocialNetworkNode
Returns:
the enabled state.

setCustomerEnabled

public void setCustomerEnabled(java.lang.String enabled)
Sets the customer enabled OSN state of the node.

Overrides:
setCustomerEnabled in class SocialNetworkNode
Parameters:
enabled - the customer enabled OSN state.

getCustomerEnabled

public java.lang.String getCustomerEnabled()
Gets the customer enabled OSN state of the node.

Overrides:
getCustomerEnabled in class SocialNetworkNode
Returns:
the customer enabled OSN state.

setDisplayName

public void setDisplayName(java.lang.String displayName)
Sets the display name of the node.

Specified by:
setDisplayName in class SocialNetworkNode
Parameters:
displayName - the display name.

getDisplayName

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

Specified by:
getDisplayName in class SocialNetworkNode
Returns:
the node display name.

setStatusMessageEnabled

public void setStatusMessageEnabled(boolean statusMessageEnabled)
Sets whether or not a status message can be available for the node.

Overrides:
setStatusMessageEnabled in class SocialNetworkNode
Parameters:
statusMessageEnabled - whether there can be a status message.

getStatusMessageEnabled

public boolean getStatusMessageEnabled()
Gets whether or not a status message can be available for the node.

Overrides:
getStatusMessageEnabled in class SocialNetworkNode
Returns:
true if there can be a status message.

setStatusMessage

public void setStatusMessage(java.lang.String statusMessage)
Sets the status message for the node.

Overrides:
setStatusMessage in class SocialNetworkNode
Parameters:
statusMessage - the status message.

getStatusMessage

public java.lang.String getStatusMessage()
Gets the status message for the node.

Overrides:
getStatusMessage in class SocialNetworkNode
Returns:
the status message.

getOsnEnabledAttributes

public java.util.List<SocialNetworkNodeAttribute> getOsnEnabledAttributes(boolean includeMandatory)
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.
Returns:
OSN enable attribute list.

getAttributes

public java.util.List<SocialNetworkNodeAttribute> getAttributes(boolean includeMandatory)
Provide the list of attributes of the View Object .

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

isViewObjectNode

public boolean isViewObjectNode()
Provide whether this node represents a view object.

Overrides:
isViewObjectNode in class SocialNetworkNode
Returns:
true if this is a view object node.

setViewLink

public void setViewLink(ViewLinkUsageNode viewLink)
Sets the view link to the parent VO.

Parameters:
viewLink - the view link.

getViewLink

public ViewLinkUsageNode getViewLink()
Gets the view link to the parent VO.

Returns:
viewLink the view link.

fromXML

public static SocialNetworkNode fromXML(org.w3c.dom.Element xmlElement,
                                        SocialNetworkNode parent,
                                        SocialNetworkStructureStorage storage,
                                        java.lang.String appKey,
                                        java.lang.String appName,
                                        java.lang.String appModuleId)
Parses the view object element node provided, validates it is a ViewUsage xml node and requests the parsing of its nested VO child nodes.

Parameters:
xmlElement - the node to parse.
parent - the parent of the view object.
storage - the container for the list of structure objects in the data control.
appKey - the application family module key that the ViewObject resides within.
appName - the application family module name that the ViewObject resides within.
appModuleId - the module id of the application family.
Returns:
an instance of this class based upon the node provided with child nodes loaded internally.

equals

public boolean equals(java.lang.Object object)

Overrides:
equals in class SocialNetworkNode

hashCode

public int hashCode()

Overrides:
hashCode in class SocialNetworkNode

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

E22562-07

Copyright © 2013 Oracle. All Rights Reserved.