oracle.apps.fnd.applcore.socialnetwork.ui.managed
Class SocialNetworkSessionBean

java.lang.Object
  oracle.apps.fnd.applcore.socialnetwork.ui.managed.SocialNetworkSessionBean

All Implemented Interfaces:

java.io.Serializable

Deprecated. Do not use this class, it will be removed in 11.1.1.8.0 timeframe. Use methods in oracle.apps.fnd.applcore.oaext.osn.util.OsnUtils instead.

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

Session bean for performing Manual registration of ViewObject Rows into the Oracle Social Network. The bean is registered as part of the UIComponents bean registrations and is available via EL using the name "SocialNetworkSessionBean". There are five primary types of call to this session bean:

• isRowOsnDisabledOrSent - Determine if the row that is provided has already been sent to OSN in this current session. This is to be used on a UIComponent for its disabled attribute. The method will also return true if one of the following is met: No session exists, ATG Lite enabled, No OSN libraries are on the classpath, View Object for row is not OSN enabled as manual, There is no OSN endpoint in topology manager. There is an alternate method (getMapRowOsnDisabledOrSent) using a map to provide the callback into the session bean which will not require a Java backing bean on the consuming application.
• registerRowWithOsn - Takes the row provided and sends it to OSN.
• osnSocialObjectID - Retrieve the ID used within OSN representing the Social Object. This is to be used whenever the Social Object ID is required based upon a row (most likely from an OSN Declarative Component). There is a pure Java call as well as a Map based alternate method using a map to provide the callback into the session bean which will not require a Java backing bean on the consuming application.
• isEnvironmentOsnEnabled - Based upon the environmental setup determine whether OSN is enabled. The method will return false if one of the following is met: No session exists, ATG Lite enabled, No OSN libraries are on the classpath, There is no OSN endpoint in topology manager
• isVoOsnEnabled - Determine if the View Object that is provided is configured so that it is enabled for OSN integration. The method will also return false if one of the following is met: No session exists, ATG Lite enabled, No OSN libraries are on the classpath, View Object is not OSN enabled as manual or automatic, There is no OSN endpoint in topology manager. There is an alternate method (getMapVoOsnDisabledOrSent) using a map to provide the callback into the session bean.

Since:

11.1.1.7.0

Version:

$Header: atgpf/applcore/applications/UIComponents/ViewController/src/oracle/apps/fnd/applcore/socialnetwork/ui/managed/SocialNetworkSessionBean.java /st_atgpf_pt-11.1.1.7.0/4 2012/12/12 15:22:45 dagroves Exp $

See Also:

Serialized Form

Field Summary

static java.lang.String

OSN_BEAN_NAME Deprecated. The registered name of the Bean in faces-config.xml.

Constructor Summary

SocialNetworkSessionBean()
Deprecated. Default Constructor.

Method Summary

static SocialNetworkSessionBean	getInstance() Deprecated. Provides a programattic way of accessing the SocialNetworkSessionBean from the session.
java.util.Map	getMapRowOsnDisabledOrSent() Deprecated. Provides a Map which allows for the determination of whether a row has been sent to OSN in the current session.
java.util.Map	getMapVoOsnEnabled() Deprecated. Provides a Map which allows for the determination of whether a view object has been configured for OSN Enablement.
java.util.Map	getOsnSocialObjectID() Deprecated. Provides a Map which allows for the determination of what the Identifier used for the Social Object in OSN.
java.lang.String	getOsnSocialObjectID(oracle.jbo.Row row) Deprecated. Based upon the row passed in determine what the identifier that will be used for representing the Social Object.
boolean	isEnvironmentOsnEnabled() Deprecated. Determination whether the environment meets one of the following criteria one of the following is met: No session exists, ATG Lite enabled, No OSN libraries are on the classpath, There is no OSN endpoint in topology manager.
java.lang.Boolean	isRowOsnDisabledOrSent(oracle.jbo.Row row) Deprecated. Determination whether the row has been sent to OSN in the current session.
java.lang.Boolean	isRowOsnDisabledOrSent(java.lang.String iteratorName, oracle.jbo.Key rowKey) Deprecated. Determination whether the row has been sent to OSN in the current session.
java.lang.Boolean	isRowOsnDisabledOrSent(javax.faces.component.UIComponent osnComponent) Deprecated. Determination whether the row has been sent to OSN in the current session.
boolean	isVoOsnEnabled(oracle.jbo.ViewObject vo) Deprecated. Determination whether the row meets one of the following criteria one of the following is met: No session exists, ATG Lite enabled, No OSN libraries are on the classpath, View Object for row is not OSN enabled as manual or automatic, There is no OSN endpoint in topology manager.
void	registerRowWithOsn(oracle.jbo.Row row) Deprecated. API to send the row provided to OSN.
void	registerRowWithOsn(java.lang.String iteratorName, oracle.jbo.Key rowKey) Deprecated. API to send the row provided to OSN.
void	registerRowWithOsnActionListener(javax.faces.event.ActionEvent actionEvent) Deprecated. Prefered API to send the row provided to OSN.

Methods inherited from class java.lang.Object

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

Field Detail

OSN_BEAN_NAME

public static final java.lang.String OSN_BEAN_NAME

Deprecated.

The registered name of the Bean in faces-config.xml.

See Also:

Constant Field Values

Constructor Detail

SocialNetworkSessionBean

public SocialNetworkSessionBean()

Deprecated.

Default Constructor.

Method Detail

getInstance

public static SocialNetworkSessionBean getInstance()

Deprecated.

Provides a programattic way of accessing the SocialNetworkSessionBean from the session. A bean will always be returned from a call to this method.

Returns:

the SocialNetworkSessionBean from the session.

isRowOsnDisabledOrSent

public java.lang.Boolean isRowOsnDisabledOrSent(oracle.jbo.Row row)

Deprecated.

Determination whether the row has been sent to OSN in the current session. The primary use case for this if the Row object can be determined from a applications backing bean to see if it has been sent to OSN in this session. The method will also return true if one of the following is met: No session exists, ATG Lite enabled, No OSN libraries are on the classpath, View Object for row is not OSN enabled as manual, There is no OSN endpoint in topology manager.

Parameters:

row - the row to check.

Returns:

True if the row has already been sent to OSN in this session, otherwise false.

getMapVoOsnEnabled

public java.util.Map getMapVoOsnEnabled()

Deprecated.

Provides a Map which allows for the determination of whether a view object has been configured for OSN Enablement. The Map will always return a boolean value stating whether the key passed in is a View Object and has been OSN enabled. If any other type is passed into the get for the map then false will be returned.

Returns:

The Map containing the information about whether the View Object is OSN Enabeld.

isVoOsnEnabled

public boolean isVoOsnEnabled(oracle.jbo.ViewObject vo)

Deprecated.

Determination whether the row meets one of the following criteria one of the following is met: No session exists, ATG Lite enabled, No OSN libraries are on the classpath, View Object for row is not OSN enabled as manual or automatic, There is no OSN endpoint in topology manager.

Parameters:

vo - the View Object to check.

Returns:

True if the row is OSN enabled.

isEnvironmentOsnEnabled

public boolean isEnvironmentOsnEnabled()

Deprecated.

Determination whether the environment meets one of the following criteria one of the following is met: No session exists, ATG Lite enabled, No OSN libraries are on the classpath, There is no OSN endpoint in topology manager.

Returns:

True if the environment is OSN enabled.

isRowOsnDisabledOrSent

public java.lang.Boolean isRowOsnDisabledOrSent(javax.faces.component.UIComponent osnComponent)

Deprecated.

Determination whether the row has been sent to OSN in the current session. The method will also return true if one of the following is met: No session exists, ATG Lite enabled, No OSN libraries are on the classpath, View Object for row is not OSN enabled as manual, There is no OSN endpoint in topology manager. To allow this method to be called the UIComponent must have an attribute called osnRow defined which contains the EL expression to the row that is to be sent to OSN. Below is an example of how this can be setup against a button:

   <af:commandButton text="Button Text" id="cb1"
                         binding="#{<backing bean binding for button>}
                         disabled="#{<backing bean method which calls isRowOsnDisabledOrSent with binding>}" >
     <f:attribute name="osnRow" value="#{data.<PageDef>.<Iterator>.currentRow}"/>
    </af:commandButton>
 

Parameters:

osnComponent - the component which has the osnRow attribute.

Returns:

True if the row has already been sent to OSN in this session, otherwise false.

isRowOsnDisabledOrSent

public java.lang.Boolean isRowOsnDisabledOrSent(java.lang.String iteratorName,
                                                oracle.jbo.Key rowKey)

Deprecated.

Determination whether the row has been sent to OSN in the current session. This API can be used from a consuming applications backing bean to allow for the scenario where the primary key for the iterator containing the data to be sent is to be derived based upon other factors than the current row and the backing bean does not have direct access to the row to use the isRowOsnDisabledOrSent(row) variant of this API. This method will create a temporary instance of the VO that the iterator provided uses (the iterator instance will not be modified) and use that to look up the row to send to OSN. The method will also return true if one of the following is met: No session exists, ATG Lite enabled, No OSN libraries are on the classpath, View Object for row is not OSN enabled as manual, There is no OSN endpoint in topology manager.

Parameters:

iteratorName - the name of the iterator containing the View Object row to be send to OSN.

rowKey - the primary key of the row in the iterators View Object to be sent to OSN.

Returns:

True if the row has already been sent to OSN in this session, otherwise false.

getMapRowOsnDisabledOrSent

public java.util.Map getMapRowOsnDisabledOrSent()

Deprecated.

Provides a Map which allows for the determination of whether a row has been sent to OSN in the current session. The primary use case for this is for passing a Row directly into the EL expression of the disabled clause of the UIComponent. The Map will always return a boolean value stating whether the key passed in is a Row that has been sent to OSN. If any other type is passed into the get for the map then false will be returned. Example Usage:

   <af:commandButton text="Button Text" id="cb1"
                        disabled="#{SocialNetworkSessionBean.mapRowOsnDisabledOrSent[data.<PageDef>.<Iterator>.currentRow]}" />
 

Returns:

The Map containing the information about whether the row has already been sent to OSN.

registerRowWithOsn

public void registerRowWithOsn(oracle.jbo.Row row)

Deprecated.

API to send the row provided to OSN. The intended use of this API will be either calling it programatically

SocialNetworkSessionBean.getInstance().registerRowWithOsn(row)

-or- via a taskflow Method Call to send the current row in a PageDef iterator to OSN. In this Method Call case the following values can be used:

 Method: #{SocialNetworkSessionBean.registerRowWithOsn}
 Parameters:
   Class             Value
   oracle.jbo.Row    #{data.<PageDef>.<Iterator>.currentRow}
 

Parameters:

row - the row to send to OSN.

registerRowWithOsnActionListener

public void registerRowWithOsnActionListener(javax.faces.event.ActionEvent actionEvent)

Deprecated.

Prefered API to send the row provided to OSN. This API is to be used when UIComponent has an actionListener defined which will be used to send the row to OSN. To allow this method to be called the UIComponent must have an attribute called osnRow defined which contains the EL expression to the row that is to be sent to OSN. Below is an example of how this can be setup against a button:

   <af:commandButton text="Button Text" id="cb1"
                         actionListener="#{SocialNetworkSessionBean.registerRowWithOsnActionListener}" >
     <f:attribute name="osnRow" value="#{data.<PageDef>.<Iterator>.currentRow}"/>
    </af:commandButton>
 

Parameters:

actionEvent - the event action that occured on the UIComponent.

registerRowWithOsn

public void registerRowWithOsn(java.lang.String iteratorName,
                               oracle.jbo.Key rowKey)

Deprecated.

API to send the row provided to OSN. This API can be used from a consuming applications backing bean to allow for the scenario where the primary key for the iterator containing the data to be sent is to be derived based upon other factors than the current row and the backing bean does not have direct access to the row to use the registerRowWithOsn(row) variant of this API. This method will create a temporary instance of the VO that the iterator provided uses (the iterator instance will not be modified) and use that to look up the row to send to OSN.

Parameters:

iteratorName - the name of the iterator containing the View Object row to be send to OSN.

rowKey - the primary key of the row in the iterators View Object to be sent to OSN.

getOsnSocialObjectID

public java.util.Map getOsnSocialObjectID()

Deprecated.

Provides a Map which allows for the determination of what the Identifier used for the Social Object in OSN. Example Usage:

Returns:

The Map containing the information about the OSN Social Object Identifier.

getOsnSocialObjectID

public java.lang.String getOsnSocialObjectID(oracle.jbo.Row row)

Deprecated.

Based upon the row passed in determine what the identifier that will be used for representing the Social Object.

Parameters:

row - the row to send to OSN.

Returns:

The Social Object ID for the Row, null if the key is not a row or there is an issue during lookup.