oracle.apps.fnd.applcore.oaext.osn.social
Interface SocialApiRuntime

All Known Implementing Classes:

SocialApiImpl

public interface SocialApiRuntime

The interface that an API must conform to if it is to be able to perform sending of Social Network Objects to Oracle Social Network.

Since:

11.1.1.7.0

Version:

$Header: atgpf/applcore/applications/Common/Model/src/oracle/apps/fnd/applcore/oaext/osn/social/SocialApiRuntime.java /st_atgpf_pt-11.1.1.7.0/2 2012/11/29 21:30:55 dagroves Exp $

Method Summary

void	addMember(java.lang.String objectId, java.lang.String member) Add member to the social object represented by row.
void	init() Initialization for the API instance.
void	init(boolean checkConnection) Initialization for the API instance.
boolean	isPublished(java.lang.String objectId) Has the Object represented by objectId been published?
void	removeMember(java.lang.String objectId, java.lang.String member) Remove member from the social object represented by row.
void	sendObjectToOsn(SocialApiAdapter osnObject) Send the ojbect payload to Oracle Social Network.

Method Detail

init

void init()
          throws OsnPublishException

Initialization for the API instance. An init method method must be called prior to other methods in this class. This is a heavier weight version equivalent to init(true), it will test connections. The OSN server URL will be retrieved from Topology Manager (OSN module) and the login credentials will be looked up by the OSN connection manager API.

Throws:

OsnPublishException - if any problems.

init

void init(boolean checkConnection)
          throws OsnPublishException

Initialization for the API instance. An init method method must be called prior to other methods in this class. The OSN server URL will be retrieved from Topology Manager (OSN module) and the login credentials will be looked up by the OSN connection manager API.

Parameters:

checkConnection - do we check the connection as well.

Throws:

OsnPublishException - if any problems.

sendObjectToOsn

void sendObjectToOsn(SocialApiAdapter osnObject)
                     throws OsnPublishException

Send the ojbect payload to Oracle Social Network. The osnObject contains the information about whether to do a insert/update or delete call to OSN.

Parameters:

osnObject - - they payload to send to OSN.

Throws:

java.lang.Exception

OsnPublishException

addMember

void addMember(java.lang.String objectId,
               java.lang.String member)
               throws OsnPublishException

Add member to the social object represented by row.

Parameters:

objectId - the row to add member to.

member - the user to add.

Throws:

OsnPublishException - if there are any problems. The nested exception (if available) will contain Osn error details.

removeMember

void removeMember(java.lang.String objectId,
                  java.lang.String member)
                  throws OsnPublishException

Remove member from the social object represented by row.

Parameters:

objectId - the row to remove member from.

member - the user to remove.

Throws:

java.lang.NullPointerException - if row or member are null.

java.lang.IllegalArgumentException - if row not instanceof OAViewRowImpl.

java.lang.Exception - if there is a problem removing the member from Osn.

OsnPublishException

isPublished

boolean isPublished(java.lang.String objectId)
                    throws OsnPublishException

Has the Object represented by objectId been published?

Parameters:

objectId - the id of the row to check.

Returns:

true if published, fale otherwise.

Throws:

OsnPublishException - if any problem with osn infrastructure.