org.exoplatform.social.core.manager

Interface RelationshipManager

public interface RelationshipManager

Controls connections between identities. This includes:

• Getting relationship between 2 identities.
• Interacting between identities: inviting, confirming, denying and ignoring.
• Getting a list access which contains connections, incoming and outgoing.

Method Summary

Methods

Modifier and Type	Method and Description
void	confirm(org.exoplatform.social.core.identity.model.Identity invitedIdentity, org.exoplatform.social.core.identity.model.Identity invitingIdentity) Confirms to connect to an identity who sent invitation.
void	confirm(org.exoplatform.social.core.relationship.model.Relationship relationship) Deprecated. Use confirm(Identity, Identity) instead. Will be removed by 4.0.x.
org.exoplatform.social.core.relationship.model.Relationship	create(org.exoplatform.social.core.identity.model.Identity sender, org.exoplatform.social.core.identity.model.Identity receiver) Deprecated. Use invite(Identity, Identity) instead. Will be removed by 4.0.x.
void	delete(org.exoplatform.social.core.relationship.model.Relationship existingRelationship) Deletes an existing relationship.
void	deny(org.exoplatform.social.core.identity.model.Identity invitedIdentity, org.exoplatform.social.core.identity.model.Identity invitingIdentity) Denies to connect to an identity who sent invitation.
void	deny(org.exoplatform.social.core.relationship.model.Relationship relationship) Deprecated. Use deny(Identity, Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.identity.model.Identity>	findRelationships(org.exoplatform.social.core.identity.model.Identity ownerIdentity, org.exoplatform.social.core.relationship.model.Relationship.Type relationshipType) Deprecated. Use getIncoming(Identity) or getOutgoing(Identity) instead. Will be removed by 4.0.x.
List	findRoute(org.exoplatform.social.core.identity.model.Identity sender, org.exoplatform.social.core.identity.model.Identity receiver) Deprecated. Should use get(Identity, Identity) instead. Will be removed by 4.0.x.
org.exoplatform.social.core.relationship.model.Relationship	get(org.exoplatform.social.core.identity.model.Identity identity1, org.exoplatform.social.core.identity.model.Identity identity2) Gets a relationship between 2 identities.
org.exoplatform.social.core.relationship.model.Relationship	get(String relationshipId) Gets a relationship by its Id.
List<org.exoplatform.social.core.relationship.model.Relationship>	getAll(org.exoplatform.social.core.identity.model.Identity identity) Deprecated. Use getAllWithListAccess(Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.relationship.model.Relationship>	getAll(org.exoplatform.social.core.identity.model.Identity identity, List<org.exoplatform.social.core.identity.model.Identity> identities) Deprecated. Use getAllWithListAccess(Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.relationship.model.Relationship>	getAll(org.exoplatform.social.core.identity.model.Identity identity, org.exoplatform.social.core.relationship.model.Relationship.Type type, List<org.exoplatform.social.core.identity.model.Identity> identities) Deprecated. Use getAllWithListAccess(Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.relationship.model.Relationship>	getAllRelationships(org.exoplatform.social.core.identity.model.Identity identity) Deprecated. Use getAllWithListAccess(Identity) instead. Will be removed by 4.0.x.
ListAccess<org.exoplatform.social.core.identity.model.Identity>	getAllWithListAccess(org.exoplatform.social.core.identity.model.Identity existingIdentity) Gets a list access which contains all identities who were connected, were invited or invited a provided identity.
List<org.exoplatform.social.core.relationship.model.Relationship>	getConfirmed(org.exoplatform.social.core.identity.model.Identity identity) Deprecated. Use getConnections(Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.relationship.model.Relationship>	getConfirmed(org.exoplatform.social.core.identity.model.Identity identity, List<org.exoplatform.social.core.identity.model.Identity> identities) Deprecated. Use getConnections(Identity) instead. Will be removed by 4.0.x.
ListAccess<org.exoplatform.social.core.identity.model.Identity>	getConnections(org.exoplatform.social.core.identity.model.Identity existingIdentity) Gets a list access which contains all identities who are connected to a provided identity.
ListAccess<org.exoplatform.social.core.identity.model.Identity>	getConnectionsByFilter(org.exoplatform.social.core.identity.model.Identity existingIdentity, org.exoplatform.social.core.profile.ProfileFilter profileFilter) Gets a list access which contains all identities who are connected to a provided identity and filtered by a profile filter.
org.exoplatform.social.core.relationship.model.Relationship.Type	getConnectionStatus(org.exoplatform.social.core.identity.model.Identity fromIdentity, org.exoplatform.social.core.identity.model.Identity toIdentity) Deprecated. Use getStatus(Identity, Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.relationship.model.Relationship>	getContacts(org.exoplatform.social.core.identity.model.Identity identity) Deprecated. Use getConnections(Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.relationship.model.Relationship>	getContacts(org.exoplatform.social.core.identity.model.Identity currIdentity, List<org.exoplatform.social.core.identity.model.Identity> identities) Deprecated. Use getConnections(Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.identity.model.Identity>	getIdentities(org.exoplatform.social.core.identity.model.Identity id) Deprecated. Use getAllWithListAccess(Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.relationship.model.Relationship>	getIncoming(org.exoplatform.social.core.identity.model.Identity receiver) Deprecated. Use getIncomingWithListAccess(Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.relationship.model.Relationship>	getIncoming(org.exoplatform.social.core.identity.model.Identity receiver, List<org.exoplatform.social.core.identity.model.Identity> identities) Deprecated. Use getIncomingWithListAccess(Identity) instead. Will be removed by 4.0.x.
ListAccess<org.exoplatform.social.core.identity.model.Identity>	getIncomingByFilter(org.exoplatform.social.core.identity.model.Identity existingIdentity, org.exoplatform.social.core.profile.ProfileFilter profileFilter) Gets a list access which contains all identities who invited to connect to a provided identity and filtered by a profile filter.
ListAccess<org.exoplatform.social.core.identity.model.Identity>	getIncomingWithListAccess(org.exoplatform.social.core.identity.model.Identity existingIdentity) Gets a list access which contains all identities who invited to connect to a provided identity.
List<org.exoplatform.social.core.identity.model.Identity>	getLastConnections(org.exoplatform.social.core.identity.model.Identity identity, int limit) Get the list of identities who are most recently connected with given user the limit number of results must be greater than 0 or an empty list will be returned
ListAccess<org.exoplatform.social.core.identity.model.Identity>	getOutgoing(org.exoplatform.social.core.identity.model.Identity existingIdentity) Gets a list access which contains all identities who were invited to connect by a provided identity.
ListAccess<org.exoplatform.social.core.identity.model.Identity>	getOutgoingByFilter(org.exoplatform.social.core.identity.model.Identity existingIdentity, org.exoplatform.social.core.profile.ProfileFilter profileFilter) Gets a list access which contains all identities who were invited by a provided identity to connect and filtered by a profile filter.
List<org.exoplatform.social.core.relationship.model.Relationship>	getPending(org.exoplatform.social.core.identity.model.Identity sender) Deprecated. Use getIncoming(Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.relationship.model.Relationship>	getPending(org.exoplatform.social.core.identity.model.Identity sender, List<org.exoplatform.social.core.identity.model.Identity> identities) Deprecated. Use getIncomingWithListAccess(Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.relationship.model.Relationship>	getPendingRelationships(org.exoplatform.social.core.identity.model.Identity identity) Deprecated. Use getIncoming(Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.relationship.model.Relationship>	getPendingRelationships(org.exoplatform.social.core.identity.model.Identity identity, boolean toConfirm) Deprecated. When toConfirm=true, use getIncoming(Identity) instead. When toConfirm=false, use getOutgoing(Identity) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.relationship.model.Relationship>	getPendingRelationships(org.exoplatform.social.core.identity.model.Identity currIdentity, List<org.exoplatform.social.core.identity.model.Identity> identities, boolean toConfirm) Deprecated. When toConfirm=true, use getIncoming(Identity) instead. When toConfirm=false use getOutgoing(Identity) instead. Will be removed by 4.0.x.
org.exoplatform.social.core.relationship.model.Relationship	getRelationship(org.exoplatform.social.core.identity.model.Identity sender, org.exoplatform.social.core.identity.model.Identity receiver) Deprecated. Use get(Identity, Identity) instead. Will be removed by 4.0.x.
org.exoplatform.social.core.relationship.model.Relationship	getRelationshipById(String id) Deprecated. Use get(String) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.relationship.model.Relationship>	getRelationshipsByIdentityId(String id) Deprecated. Use getAllWithListAccess(Identity) with identity instead. Will be removed by 4.0.x.
org.exoplatform.social.core.relationship.model.Relationship.Type	getRelationshipStatus(org.exoplatform.social.core.relationship.model.Relationship rel, org.exoplatform.social.core.identity.model.Identity id) Deprecated. Now we don't use this method to get relationship we get status of relationship object and depend on sender and receiver, we can define pending relationship or incoming relationship. But we still keep this method for build, call getStatus(Identity, Identity). This method will be removed by 4.0.x.
org.exoplatform.social.core.relationship.model.Relationship.Type	getStatus(org.exoplatform.social.core.identity.model.Identity identity1, org.exoplatform.social.core.identity.model.Identity identity2) Gets the relationship status between 2 identities.
Map<org.exoplatform.social.core.identity.model.Identity,Integer>	getSuggestions(org.exoplatform.social.core.identity.model.Identity identity, int offset, int limit) Deprecated. Use getSuggestions(org.exoplatform.social.core.identity.model.Identity, int, int, int) instead
Map<org.exoplatform.social.core.identity.model.Identity,Integer>	getSuggestions(org.exoplatform.social.core.identity.model.Identity identity, int maxConnections, int maxConnectionsToLoad, int maxSuggestions) Gets suggestions having common users with the provided identity.
void	ignore(org.exoplatform.social.core.identity.model.Identity invitedIdentity, org.exoplatform.social.core.identity.model.Identity invitingIdentity) Ignores to connect to an identity who sent invitation.
void	ignore(org.exoplatform.social.core.relationship.model.Relationship relationship) Deprecated. Use ignore(Identity, Identity) instead. Will be removed by 4.0.x.
org.exoplatform.social.core.relationship.model.Relationship	invite(org.exoplatform.social.core.identity.model.Identity sender, org.exoplatform.social.core.identity.model.Identity receiver) Deprecated. Use inviteToConnect(Identity, Identity) instead. Will be removed by 4.0.x.
org.exoplatform.social.core.relationship.model.Relationship	inviteToConnect(org.exoplatform.social.core.identity.model.Identity invitingIdentity, org.exoplatform.social.core.identity.model.Identity invitedIdentity) Invites one identity to connect to the other.
void	remove(org.exoplatform.social.core.relationship.model.Relationship relationship) Deprecated. Use delete(Relationship) instead. Will be removed by 4.0.x.
void	save(org.exoplatform.social.core.relationship.model.Relationship relationship) Deprecated. Use actions (inviteToConnect, confirm) instead. Will be removed by 4.0.x.
void	saveRelationship(org.exoplatform.social.core.relationship.model.Relationship relationship) Deprecated. Use update(Relationship) instead. Will be removed by 4.0.x.
void	update(org.exoplatform.social.core.relationship.model.Relationship existingRelationship) Updates an existing relationship.

Method Detail

get

org.exoplatform.social.core.relationship.model.Relationship get(String relationshipId)

Gets a relationship by its Id.

Parameters:

relationshipId - Id of the relationship.

Returns:

The existing relationship or null.

Since:

1.2.0-GA

Level API:

Platform

get

org.exoplatform.social.core.relationship.model.Relationship get(org.exoplatform.social.core.identity.model.Identity identity1,
                                                              org.exoplatform.social.core.identity.model.Identity identity2)

Gets a relationship between 2 identities.

Parameters:

identity1 - The identity 1.

identity2 - The identity 2.

Returns:

The relationship between 2 identities.

Since:

1.2.0-GA

Level API:

Platform

update

void update(org.exoplatform.social.core.relationship.model.Relationship existingRelationship)

Updates an existing relationship.

Parameters:

existingRelationship - The existing relationship to be updated.

Since:

1.2.0-GA

Level API:

Platform

delete

void delete(org.exoplatform.social.core.relationship.model.Relationship existingRelationship)

Deletes an existing relationship.

Parameters:

existingRelationship - The existing relationship to be deleted.

Since:

1.2.0-GA

Level API:

Platform

inviteToConnect

org.exoplatform.social.core.relationship.model.Relationship inviteToConnect(org.exoplatform.social.core.identity.model.Identity invitingIdentity,
                                                                          org.exoplatform.social.core.identity.model.Identity invitedIdentity)

Invites one identity to connect to the other. The first argument must be the sender identity. The second argument must be the identity who is invited to connect.

One identity is not allowed to invite himself to connect.

Parameters:

invitingIdentity - The sender identity.

invitedIdentity - The identity who is invited.

Since:

1.2.0-GA

Level API:

Platform

confirm

void confirm(org.exoplatform.social.core.identity.model.Identity invitedIdentity,
           org.exoplatform.social.core.identity.model.Identity invitingIdentity)

Confirms to connect to an identity who sent invitation.

Parameters:

invitedIdentity - The identity who gets invitation.

invitingIdentity - The identity who invites another.

Since:

1.2.0-GA

Level API:

Platform

deny

void deny(org.exoplatform.social.core.identity.model.Identity invitedIdentity,
        org.exoplatform.social.core.identity.model.Identity invitingIdentity)

Denies to connect to an identity who sent invitation.

Parameters:

invitedIdentity - The identity who gets invitation.

invitingIdentity - The identity who invites another.

Since:

1.2.0-GA

Level API:

Platform

ignore

void ignore(org.exoplatform.social.core.identity.model.Identity invitedIdentity,
          org.exoplatform.social.core.identity.model.Identity invitingIdentity)

Ignores to connect to an identity who sent invitation. Once being ignored, the inviting identity cannot invite any more.

Parameters:

invitedIdentity - The identity who gets invitation.

invitingIdentity - The identity who invites another.

Since:

1.2.0-GA

Level API:

Platform

getConnections

ListAccess<org.exoplatform.social.core.identity.model.Identity> getConnections(org.exoplatform.social.core.identity.model.Identity existingIdentity)

Gets a list access which contains all identities who are connected to a provided identity.

Parameters:

existingIdentity - The existing provided identity.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

getIncomingWithListAccess

ListAccess<org.exoplatform.social.core.identity.model.Identity> getIncomingWithListAccess(org.exoplatform.social.core.identity.model.Identity existingIdentity)

Gets a list access which contains all identities who invited to connect to a provided identity.

Parameters:

existingIdentity - The existing provided identity.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

getOutgoing

ListAccess<org.exoplatform.social.core.identity.model.Identity> getOutgoing(org.exoplatform.social.core.identity.model.Identity existingIdentity)

Gets a list access which contains all identities who were invited to connect by a provided identity.

Parameters:

existingIdentity - The existing provided identity.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

getAllWithListAccess

ListAccess<org.exoplatform.social.core.identity.model.Identity> getAllWithListAccess(org.exoplatform.social.core.identity.model.Identity existingIdentity)

Gets a list access which contains all identities who were connected, were invited or invited a provided identity.

Parameters:

existingIdentity - The existing provided identity.

Returns:

The list access.

Since:

1.2.0-GA

Level API:

Platform

getStatus

org.exoplatform.social.core.relationship.model.Relationship.Type getStatus(org.exoplatform.social.core.identity.model.Identity identity1,
                                                                         org.exoplatform.social.core.identity.model.Identity identity2)

Gets the relationship status between 2 identities.

Parameters:

identity1 - The identity 1.

identity2 - The identity 2.

Returns:

The relationship type.

Since:

1.2.0-GA

Level API:

Platform

invite

@Deprecated
org.exoplatform.social.core.relationship.model.Relationship invite(org.exoplatform.social.core.identity.model.Identity sender,
                                                                            org.exoplatform.social.core.identity.model.Identity receiver)
                                                                   throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use inviteToConnect(Identity, Identity) instead. Will be removed by 4.0.x.

Creates a connection invitation between 2 identities.

Parameters:

sender - The inviter.

receiver - The invitee.

Returns:

The PENDING relation.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException

Level API:

Provisional

getRelationshipById

@Deprecated
org.exoplatform.social.core.relationship.model.Relationship getRelationshipById(String id)
                                                                                throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use get(String) instead. Will be removed by 4.0.x.

Gets a relationship by a given Id.

Parameters:

id - The given Id.

Returns:

The relationship.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

save

@Deprecated
void save(org.exoplatform.social.core.relationship.model.Relationship relationship)
          throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use actions (inviteToConnect, confirm) instead. Will be removed by 4.0.x.

Saves a relationship.

Parameters:

relationship - The relationship to be saved.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

confirm

@Deprecated
void confirm(org.exoplatform.social.core.relationship.model.Relationship relationship)
             throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use confirm(Identity, Identity) instead. Will be removed by 4.0.x.

Marks a relationship as "confirmed".

Parameters:

relationship - The relationship to be marked as "confirmed".

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

deny

@Deprecated
void deny(org.exoplatform.social.core.relationship.model.Relationship relationship)
          throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use deny(Identity, Identity) instead. Will be removed by 4.0.x.

Denies a relationship.

Parameters:

relationship - The relationship to be denied.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException

Level API:

Provisional

remove

@Deprecated
void remove(org.exoplatform.social.core.relationship.model.Relationship relationship)
            throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use delete(Relationship) instead. Will be removed by 4.0.x.

Removes a relationship.

Parameters:

relationship - The relationship to be removed.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

ignore

@Deprecated
void ignore(org.exoplatform.social.core.relationship.model.Relationship relationship)
            throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use ignore(Identity, Identity) instead. Will be removed by 4.0.x.

Marks a relationship as "ignored".

Parameters:

relationship - The relationship to be marked as "ignored".

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

getPendingRelationships

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getPendingRelationships(org.exoplatform.social.core.identity.model.Identity identity)
                                                                                          throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getIncoming(Identity) instead. Will be removed by 4.0.x.

Returns all pending relationships: sent.

Parameters:

identity - The identity.

Returns:

The pending relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

getPendingRelationships

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getPendingRelationships(org.exoplatform.social.core.identity.model.Identity identity,
                                                                                                   boolean toConfirm)
                                                                                          throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. When toConfirm=true, use getIncoming(Identity) instead. When toConfirm=false, use getOutgoing(Identity) instead. Will be removed by 4.0.x.

Gets a list of pending relationships that were received but not confirmed or were sent but not confirmed.

Parameters:

identity - The identity.

toConfirm - If "true", it returns a list of pending relationships received but not confirmed. If "false", it returns a list of pending relationships sent but not confirmed.

Returns:

The list of pending relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

getPendingRelationships

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getPendingRelationships(org.exoplatform.social.core.identity.model.Identity currIdentity,
                                                                                                   List<org.exoplatform.social.core.identity.model.Identity> identities,
                                                                                                   boolean toConfirm)
                                                                                          throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. When toConfirm=true, use getIncoming(Identity) instead. When toConfirm=false use getOutgoing(Identity) instead. Will be removed by 4.0.x.

Gets a list of pending relationships that were received but not confirmed or were sent but not confirmed.

Parameters:

currIdentity - The current identity.

identities - The identities.

toConfirm - If "true", it returns a list of pending relationships received but not confirmed. If "false", it returns a list of pending relationships sent but not confirmed.

Returns:

The list of pending relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

getContacts

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getContacts(org.exoplatform.social.core.identity.model.Identity currIdentity,
                                                                                       List<org.exoplatform.social.core.identity.model.Identity> identities)
                                                                              throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getConnections(Identity) instead. Will be removed by 4.0.x.

Gets contacts matching with the current identity.

Parameters:

currIdentity - The current identity.

identities - The identities.

Returns:

The contacts.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

getContacts

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getContacts(org.exoplatform.social.core.identity.model.Identity identity)
                                                                              throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getConnections(Identity) instead. Will be removed by 4.0.x.

Gets contacts of an identity.

Parameters:

identity - The identity.

Returns:

The contacts.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

getAllRelationships

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getAllRelationships(org.exoplatform.social.core.identity.model.Identity identity)
                                                                                      throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getAllWithListAccess(Identity) instead. Will be removed by 4.0.x.

Returns all relationships associated with a given identity.

Parameters:

identity - The identity.

Returns:

The relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

getRelationshipsByIdentityId

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getRelationshipsByIdentityId(String id)
                                                                                               throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getAllWithListAccess(Identity) with identity instead. Will be removed by 4.0.x.

Returns all relationships associated with a given identityId.

Parameters:

id - Id of the identity.

Returns:

The relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

getIdentities

@Deprecated
List<org.exoplatform.social.core.identity.model.Identity> getIdentities(org.exoplatform.social.core.identity.model.Identity id)
                                                                        throws Exception

Deprecated. Use getAllWithListAccess(Identity) instead. Will be removed by 4.0.x.

Returns all identities associated with a given identity.

Parameters:

id - The given identity.

Returns:

The identities.

Throws:

Exception - the exception

Level API:

Provisional

create

@Deprecated
org.exoplatform.social.core.relationship.model.Relationship create(org.exoplatform.social.core.identity.model.Identity sender,
                                                                            org.exoplatform.social.core.identity.model.Identity receiver)

Deprecated. Use invite(Identity, Identity) instead. Will be removed by 4.0.x.

Creates a relationship.

Parameters:

sender - The sender.

receiver - The receiver.

Returns:

The relationship.

Level API:

Provisional

saveRelationship

@Deprecated
void saveRelationship(org.exoplatform.social.core.relationship.model.Relationship relationship)
                      throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use update(Relationship) instead. Will be removed by 4.0.x.

Saves a relationship.

Parameters:

relationship - The relationship to be saved.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

findRoute

@Deprecated
List findRoute(org.exoplatform.social.core.identity.model.Identity sender,
                        org.exoplatform.social.core.identity.model.Identity receiver)
               throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Should use get(Identity, Identity) instead. Will be removed by 4.0.x.

Gets a relationship between 2 identities.

Parameters:

sender - The identity 1.

receiver - The identity 2.

Returns:

The relationship.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException

Level API:

Provisional

getRelationship

@Deprecated
org.exoplatform.social.core.relationship.model.Relationship getRelationship(org.exoplatform.social.core.identity.model.Identity sender,
                                                                                     org.exoplatform.social.core.identity.model.Identity receiver)
                                                                            throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use get(Identity, Identity) instead. Will be removed by 4.0.x.

Gets a relationship between 2 identities.

Parameters:

sender - The identity 1.

receiver - The identity 2.

Returns:

The relationship.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Level API:

Provisional

findRelationships

@Deprecated
List<org.exoplatform.social.core.identity.model.Identity> findRelationships(org.exoplatform.social.core.identity.model.Identity ownerIdentity,
                                                                                     org.exoplatform.social.core.relationship.model.Relationship.Type relationshipType)
                                                                            throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getIncoming(Identity) or getOutgoing(Identity) instead. Will be removed by 4.0.x.

Finds all identities having relationshipType with the ownerIdentity.

Parameters:

ownerIdentity - The owner identity.

relationshipType - The relationship type.

Returns:

The identities.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException

Since:

1.2.0-Beta1

Level API:

Provisional

getRelationshipStatus

@Deprecated
org.exoplatform.social.core.relationship.model.Relationship.Type getRelationshipStatus(org.exoplatform.social.core.relationship.model.Relationship rel,
                                                                                                org.exoplatform.social.core.identity.model.Identity id)

Deprecated. Now we don't use this method to get relationship we get status of relationship object and depend on sender and receiver, we can define pending relationship or incoming relationship. But we still keep this method for build, call getStatus(Identity, Identity). This method will be removed by 4.0.x.

Gets the relationship status.

Parameters:

rel - The relationship.

id - The identity.

Returns:

The relationship status.

Level API:

Provisional

getConnectionStatus

@Deprecated
org.exoplatform.social.core.relationship.model.Relationship.Type getConnectionStatus(org.exoplatform.social.core.identity.model.Identity fromIdentity,
                                                                                              org.exoplatform.social.core.identity.model.Identity toIdentity)
                                                                                     throws Exception

Deprecated. Use getStatus(Identity, Identity) instead. Will be removed by 4.0.x.

Gets the connection status between 2 identities.

Parameters:

fromIdentity - The identity 1.

toIdentity - The identity 2.

Returns:

The connection status.

Throws:

Exception

Since:

1.1.1

Level API:

Provisional

getPending

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getPending(org.exoplatform.social.core.identity.model.Identity sender)
                                                                             throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getIncoming(Identity) instead. Will be removed by 4.0.x.

Gets all pending relationships of a sender.

Parameters:

sender - The sender.

Returns:

The pending relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Since:

1.2.0-Beta1

Level API:

Provisional

getPending

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getPending(org.exoplatform.social.core.identity.model.Identity sender,
                                                                                      List<org.exoplatform.social.core.identity.model.Identity> identities)
                                                                             throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getIncomingWithListAccess(Identity) instead. Will be removed by 4.0.x.

Gets pending relationships of a sender that match with identities.

Parameters:

sender - The sender.

identities - The identities.

Returns:

The pending relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Since:

1.2.0-Beta1

Level API:

Provisional

getIncoming

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getIncoming(org.exoplatform.social.core.identity.model.Identity receiver)
                                                                              throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getIncomingWithListAccess(Identity) instead. Will be removed by 4.0.x.

Gets relationships of a receiver that are waiting for validation.

Parameters:

receiver - Identity of the receiver.

Returns:

The relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException

Since:

1.2.0-Beta1

Level API:

Provisional

getIncoming

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getIncoming(org.exoplatform.social.core.identity.model.Identity receiver,
                                                                                       List<org.exoplatform.social.core.identity.model.Identity> identities)
                                                                              throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getIncomingWithListAccess(Identity) instead. Will be removed by 4.0.x.

Gets relationships of a receiver that are waiting for validation and match with identities.

Parameters:

receiver - Identity of the receiver.

identities - The identities.

Returns:

The list of relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Since:

1.2.0-Beta1

Level API:

Provisional

getConfirmed

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getConfirmed(org.exoplatform.social.core.identity.model.Identity identity)
                                                                               throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getConnections(Identity) instead. Will be removed by 4.0.x.

Gets relationships confirmed by an identity.

Parameters:

identity - The identity.

Returns:

The confirmed relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Since:

1.2.0-Beta1

Level API:

Provisional

getConfirmed

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getConfirmed(org.exoplatform.social.core.identity.model.Identity identity,
                                                                                        List<org.exoplatform.social.core.identity.model.Identity> identities)
                                                                               throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getConnections(Identity) instead. Will be removed by 4.0.x.

Gets relationships confirmed by an identity that match with identities.

Parameters:

identity - The identity.

identities - The identities.

Returns:

The confirmed relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Since:

1.2.0-Beta1

Level API:

Provisional

getAll

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getAll(org.exoplatform.social.core.identity.model.Identity identity)
                                                                         throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getAllWithListAccess(Identity) instead. Will be removed by 4.0.x.

Gets all relationships of a given identity with other identity.

Parameters:

identity - The identity.

Returns:

The relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Since:

1.2.0-Beta1

Level API:

Provisional

getAll

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getAll(org.exoplatform.social.core.identity.model.Identity identity,
                                                                                  List<org.exoplatform.social.core.identity.model.Identity> identities)
                                                                         throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getAllWithListAccess(Identity) instead. Will be removed by 4.0.x.

Gets all relationships of a given identity.

Parameters:

identity - The identity.

identities - The identities.

Returns:

The relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Since:

1.2.0-Beta1

Level API:

Provisional

getAll

@Deprecated
List<org.exoplatform.social.core.relationship.model.Relationship> getAll(org.exoplatform.social.core.identity.model.Identity identity,
                                                                                  org.exoplatform.social.core.relationship.model.Relationship.Type type,
                                                                                  List<org.exoplatform.social.core.identity.model.Identity> identities)
                                                                         throws org.exoplatform.social.core.storage.RelationshipStorageException

Deprecated. Use getAllWithListAccess(Identity) instead. Will be removed by 4.0.x.

Gets all relationships of a given identity.

Parameters:

identity - The identity.

type - The status.

identities - The identities.

Returns:

The relationships.

Throws:

org.exoplatform.social.core.storage.RelationshipStorageException - the exception

Since:

1.2.0-Beta1

Level API:

Provisional

getConnectionsByFilter

ListAccess<org.exoplatform.social.core.identity.model.Identity> getConnectionsByFilter(org.exoplatform.social.core.identity.model.Identity existingIdentity,
                                                                                     org.exoplatform.social.core.profile.ProfileFilter profileFilter)

Gets a list access which contains all identities who are connected to a provided identity and filtered by a profile filter.

Parameters:

existingIdentity - The provided identity.

profileFilter - The provided profile filter.

Returns:

The list access.

Since:

1.2.3

Level API:

Platform

getIncomingByFilter

ListAccess<org.exoplatform.social.core.identity.model.Identity> getIncomingByFilter(org.exoplatform.social.core.identity.model.Identity existingIdentity,
                                                                                  org.exoplatform.social.core.profile.ProfileFilter profileFilter)

Gets a list access which contains all identities who invited to connect to a provided identity and filtered by a profile filter.

Parameters:

existingIdentity - The provided identity.

profileFilter - The provided profile filter.

Returns:

The list access.

Since:

1.2.3

Level API:

Platform

getOutgoingByFilter

ListAccess<org.exoplatform.social.core.identity.model.Identity> getOutgoingByFilter(org.exoplatform.social.core.identity.model.Identity existingIdentity,
                                                                                  org.exoplatform.social.core.profile.ProfileFilter profileFilter)

Gets a list access which contains all identities who were invited by a provided identity to connect and filtered by a profile filter.

Parameters:

existingIdentity - The provided identity.

profileFilter - The provided profile filter.

Returns:

The list access.

Since:

1.2.3

Level API:

Platform

getSuggestions

Map<org.exoplatform.social.core.identity.model.Identity,Integer> getSuggestions(org.exoplatform.social.core.identity.model.Identity identity,
                                                                              int maxConnections,
                                                                              int maxConnectionsToLoad,
                                                                              int maxSuggestions)

Gets suggestions having common users with the provided identity.

Parameters:

identity - The provided identity.

maxConnections - Maximum of connections that we can treat per identity. If set to a value <= 0, the limit will be disabled

maxConnectionsToLoad - In case, the maxConnections are not enough to find enough suggestion, we load more connections at the first level. If maxConnectionsToLoad or maxConnections has been set to a value <= 0, the limit will be disabled

maxSuggestions - The total amount of expected suggestions. If set to a value <= 0, the limit will be disabled

Returns:

The suggestions.

Since:

4.0.6

Level API:

Experimental

getSuggestions

@Deprecated
Map<org.exoplatform.social.core.identity.model.Identity,Integer> getSuggestions(org.exoplatform.social.core.identity.model.Identity identity,
                                                                                         int offset,
                                                                                         int limit)

Deprecated. Use getSuggestions(org.exoplatform.social.core.identity.model.Identity, int, int, int) instead

Gets suggestions having common users with the provided identity.

Parameters:

identity - The provided identity.

offset - The starting point from which suggestions are got.

limit - The limitation of suggestions.

Returns:

The suggestions.

Since:

4.0.2

Level API:

Experimental

getLastConnections

List<org.exoplatform.social.core.identity.model.Identity> getLastConnections(org.exoplatform.social.core.identity.model.Identity identity,
                                                                           int limit)

Get the list of identities who are most recently connected with given user the limit number of results must be greater than 0 or an empty list will be returned

Parameters:

identity -

limit -

Returns: