lumis.socialnetwork.socialprofile

Interface ISocialProfileProvider

All Known Implementing Classes:

AbstractSocialProfileProvider, DouiSourceSocialProfileProvider

@StableMinor(version="12.2",
             sinceVersion="6.1")
public interface ISocialProfileProvider

Social Profile Provider interface that provides methods to get social profile informations from a given user on a specific social network. This interface is implemented by AbstractSocialProfileProvider to provide a base implementation of a simple social profile provider. It's recommended to extends the AbstractSocialProfileProvider class to have better future compatibility.

This interface defines a life cycle that must be consider by the implementations. Therefore, to get information of the social profile, it's necessary to set the social network information on the social profile provider context by the method setSocialNetwork(ISocialNetwork).

Since:

6.1.0

Version:

$Revision: 23535 $ $Date: 2020-01-14 16:18:39 +0000 (Tue, 14 Jan 2020) $

See Also:

AbstractSocialProfileProvider}

Method Summary

Modifier and Type	Method and Description
ISocialProfile	getSocialProfileInformationById(String userId) Finds the social profile information by the given user id.
List<ISocialProfile>	getSocialProfileInformationsByKeyword(String keyword) Finds the social profile information based on a given keyword.
void	setSocialNetwork(ISocialNetwork socialNetwork) Sets the social network information on the scope of execution, that will be used by the others methods to extract all informations necessary.

Method Detail

setSocialNetwork

void setSocialNetwork(ISocialNetwork socialNetwork)

Sets the social network information on the scope of execution, that will be used by the others methods to extract all informations necessary.

Parameters:

socialNetwork - the social network object that contains all informations about it.

Since:

6.1.0

getSocialProfileInformationById

ISocialProfile getSocialProfileInformationById(String userId)
                                        throws PortalException

Finds the social profile information by the given user id.

Parameters:

userId - the user id.

Returns:

the social profile information by the given user id.

Throws:

PortalException

Since:

6.1.0

getSocialProfileInformationsByKeyword

List<ISocialProfile> getSocialProfileInformationsByKeyword(String keyword)
                                                    throws PortalException

Finds the social profile information based on a given keyword.

Parameters:

keyword - the keyword.

Returns:

the social profile information based on a given keyword.

Throws:

PortalException

Since:

6.1.0