oracle.apps.fnd.applcore.oaext.osn
Class OsnObjectAdapter

java.lang.Object
  oracle.apps.fnd.applcore.oaext.osn.OsnObjectAdapter

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SocialObjectAdapter

public abstract class OsnObjectAdapter
extends java.lang.Object
implements java.io.Serializable

Adapter between a View Object instance and the Oracle Social Network API's.

Since:

11.1.1.7.0

Version:

$Header: atgpf/applcore/applications/Common/Model/src/oracle/apps/fnd/applcore/oaext/osn/OsnObjectAdapter.java /st_atgpf_pt-11.1.1.7.0/5 2013/02/11 21:52:04 pacross Exp $

See Also:

Serialized Form

Field Summary

protected boolean	_isValid Whether all of the required values are available and the environment ready to send this object to OSN.
protected byte	_osnAction The action that is being taken for OSN.
static byte	OSN_ACTION_DELETE Indicates that at delete from OSN is to be performed.
static byte	OSN_ACTION_INSERT Indicates that an insert into OSN is to be performed.
static byte	OSN_ACTION_MANUAL_INSERT Indicates that at insert from OSN is to be performed for a manual row.
static byte	OSN_ACTION_MANUAL_UPDATE Indicates that at update from OSN is to be performed for a manual row.
static byte	OSN_ACTION_UNKNOWN Indicates that that the type of update being attempted is undefined.
static byte	OSN_ACTION_UPDATE Indicates that an update into OSN is to be performed.
static java.lang.String	OSN_ATTR_SENSITIVE Attribute Custom Property: Does the attribute contain sensitive data and should not be in playload.
static java.lang.String	OSN_AUTOMATIC_SEND Constant signifiying that an automatic send of the initial OSN object will be performed when a commit on the EO is triggered.
static java.lang.String	OSN_IS_ATTR_ENABLED Attribute Custom Property: Determine if OSN is enabled for the attribute.
static java.lang.String	OSN_MANUAL_SEND Constant signifiying that a manual send of the initial OSN object will be performed manually by the consumer.

Constructor Summary

OsnObjectAdapter()

Method Summary

static byte	convertEntityStateToAction(byte entityState) Convert the state attribute of an EntityObject into the corresponding OSN action.
int	getFieldCount() Provides the number of fields that can be sent to OSN.
abstract java.lang.String	getName() A name that can identify this OSN object.
abstract java.lang.String	getObjectExternalId() The unique identifier that Oracle Social Network will know the object as.
byte	getOsnAction() Gets the action to be performed by the OSN integration.
static java.lang.String	getOsnActionAsString(byte osnAction) Internal Use Only: Utility to convert an OSN action into a String.
boolean	isValid() Determines if the adaptor has all of the required information to send to OSN as well as the rules determining whether the data can be sent to OSN is satisfied.

Methods inherited from class java.lang.Object

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

Field Detail

OSN_MANUAL_SEND

public static final java.lang.String OSN_MANUAL_SEND

Constant signifiying that a manual send of the initial OSN object will be performed manually by the consumer. Applies to fnd:OSN_VO_ENABLED_BY_CUSTOMER and fnd:OSN_EO_ENABLED_BY_CUSTOMER properties.

See Also:

Constant Field Values

OSN_AUTOMATIC_SEND

public static final java.lang.String OSN_AUTOMATIC_SEND

Constant signifiying that an automatic send of the initial OSN object will be performed when a commit on the EO is triggered. Applies to fnd:OSN_VO_ENABLED_BY_CUSTOMER and fnd:OSN_EO_ENABLED_BY_CUSTOMER properties.

See Also:

Constant Field Values

OSN_ACTION_UNKNOWN

public static final byte OSN_ACTION_UNKNOWN

Indicates that that the type of update being attempted is undefined.

See Also:

Constant Field Values

OSN_ACTION_INSERT

public static final byte OSN_ACTION_INSERT

Indicates that an insert into OSN is to be performed.

See Also:

Constant Field Values

OSN_ACTION_UPDATE

public static final byte OSN_ACTION_UPDATE

Indicates that an update into OSN is to be performed.

See Also:

Constant Field Values

OSN_ACTION_DELETE

public static final byte OSN_ACTION_DELETE

Indicates that at delete from OSN is to be performed.

See Also:

Constant Field Values

OSN_ACTION_MANUAL_INSERT

public static final byte OSN_ACTION_MANUAL_INSERT

Indicates that at insert from OSN is to be performed for a manual row.

See Also:

Constant Field Values

OSN_ACTION_MANUAL_UPDATE

public static final byte OSN_ACTION_MANUAL_UPDATE

Indicates that at update from OSN is to be performed for a manual row.

See Also:

Constant Field Values

_osnAction

protected byte _osnAction

The action that is being taken for OSN.

OSN_IS_ATTR_ENABLED

public static final java.lang.String OSN_IS_ATTR_ENABLED

Attribute Custom Property: Determine if OSN is enabled for the attribute.

See Also:

Constant Field Values

OSN_ATTR_SENSITIVE

public static final java.lang.String OSN_ATTR_SENSITIVE

Attribute Custom Property: Does the attribute contain sensitive data and should not be in playload.

See Also:

Constant Field Values

_isValid

protected boolean _isValid

Whether all of the required values are available and the environment ready to send this object to OSN.

Constructor Detail

OsnObjectAdapter

public OsnObjectAdapter()

Method Detail

getOsnAction

public byte getOsnAction()

Gets the action to be performed by the OSN integration.

Returns:

the OSN action.

isValid

public boolean isValid()

Determines if the adaptor has all of the required information to send to OSN as well as the rules determining whether the data can be sent to OSN is satisfied.

Returns:

true if this adaptor can be sent to the OSN publisher.

getName

public abstract java.lang.String getName()

A name that can identify this OSN object. This will primarily be used for debugging.

Returns:

name for the OSN Object

getFieldCount

public int getFieldCount()

Provides the number of fields that can be sent to OSN.

Returns:

the number of OSN fields.

getObjectExternalId

public abstract java.lang.String getObjectExternalId()

The unique identifier that Oracle Social Network will know the object as.

Returns:

convertEntityStateToAction

public static byte convertEntityStateToAction(byte entityState)

Convert the state attribute of an EntityObject into the corresponding OSN action.

Parameters:

entityState - the state of the entity.

Returns:

the corresponding OSN action or OSN_ACTION_UNKNOWN if it cannot be determined.

getOsnActionAsString

public static java.lang.String getOsnActionAsString(byte osnAction)

Internal Use Only: Utility to convert an OSN action into a String.

Parameters:

osnAction - the action to get the String for.

Returns:

action String.