|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.BaseLocalServiceImpl
com.liferay.portlet.social.service.base.SocialRelationLocalServiceBaseImpl
com.liferay.portlet.social.service.impl.SocialRelationLocalServiceImpl
public class SocialRelationLocalServiceImpl
The social relation local service. This service provides methods to handle unidirectional or bidirectional relations between users.
Relations between users can be unidirectional or bidirectional. The type of relation is determined by an integer constant. Some example relations are co-worker, friend, romantic partner, sibling, spouse, child, enemy, follower, parent, subordinate, supervisor.
The two users participating in the relation are designated as User1 and User2. In case of unidirectional relations User1 should always be the subject of the relation. You can use the following English sentence to find out which user to use as User1 and which to use as User2:
User1 is <relation> of User2 (e.g. User1 is parent of User2; User1 is supervisor of User2)
For bidirectional relations, the service automatically generates the inverse relation.
| Field Summary |
|---|
| Fields inherited from class com.liferay.portlet.social.service.base.SocialRelationLocalServiceBaseImpl |
|---|
classNameLocalService, classNamePersistence, counterLocalService, persistedModelLocalServiceRegistry, socialRelationLocalService, socialRelationPersistence, userFinder, userLocalService, userPersistence |
| Constructor Summary | |
|---|---|
SocialRelationLocalServiceImpl()
|
|
| Method Summary | |
|---|---|
SocialRelation |
addRelation(long userId1,
long userId2,
int type)
Adds a social relation between the two users to the database. |
void |
deleteRelation(long relationId)
Removes the relation (and its inverse in case of a bidirectional relation) from the database. |
void |
deleteRelation(long userId1,
long userId2,
int type)
Removes the matching relation (and its inverse in case of a bidirectional relation) from the database. |
void |
deleteRelation(SocialRelation relation)
Removes the relation (and its inverse in case of a bidirectional relation) from the database. |
void |
deleteRelations(long userId)
Removes all relations involving the user from the database. |
void |
deleteRelations(long userId1,
long userId2)
Removes all relations between User1 and User2. |
List<SocialRelation> |
getInverseRelations(long userId,
int type,
int start,
int end)
Returns a range of all the inverse relations of the given type for which the user is User2 of the relation. |
int |
getInverseRelationsCount(long userId,
int type)
Returns the number of inverse relations of the given type for which the user is User2 of the relation. |
SocialRelation |
getRelation(long relationId)
Returns the relation identified by its primary key. |
SocialRelation |
getRelation(long userId1,
long userId2,
int type)
Returns the relation of the given type between User1 and User2. |
List<SocialRelation> |
getRelations(long userId,
int type,
int start,
int end)
Returns a range of all the relations of the given type where the user is the subject of the relation. |
List<SocialRelation> |
getRelations(long userId1,
long userId2,
int start,
int end)
Returns a range of all the relations between User1 and User2. |
int |
getRelationsCount(long userId,
int type)
Returns the number of relations of the given type where the user is the subject of the relation. |
int |
getRelationsCount(long userId1,
long userId2)
Returns the number of relations between User1 and User2. |
boolean |
hasRelation(long userId1,
long userId2,
int type)
Returns true if a relation of the given type exists where
the user with primary key userId1 is User1 of the relation
and the user with the primary key userId2 is User2 of the
relation. |
boolean |
isRelatable(long userId1,
long userId2,
int type)
Returns true if the users can be in a relation of the given
type where the user with primary key userId1 is User1 of the
relation and the user with the primary key userId2 is User2
of the relation. |
| Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl |
|---|
getClassLoader, getLocalizationMap |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SocialRelationLocalServiceImpl()
| Method Detail |
|---|
public SocialRelation addRelation(long userId1,
long userId2,
int type)
throws PortalException
userId1 - the user that is the subject of the relationuserId2 - the user at the other end of the relationtype - the type of the relation
PortalException
public void deleteRelation(long relationId)
throws PortalException
relationId - the primary key of the relation
PortalException
public void deleteRelation(long userId1,
long userId2,
int type)
throws PortalException
userId1 - the user that is the subject of the relationuserId2 - the user at the other end of the relationtype - the relation's type
PortalException
public void deleteRelation(SocialRelation relation)
throws PortalException
relation - the relation to be removed
PortalExceptionpublic void deleteRelations(long userId)
userId - the primary key of the user
public void deleteRelations(long userId1,
long userId2)
throws PortalException
userId1 - the user that is the subject of the relationuserId2 - the user at the other end of the relation
PortalException
public List<SocialRelation> getInverseRelations(long userId,
int type,
int start,
int end)
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
userId - the primary key of the usertype - the relation's typestart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
public int getInverseRelationsCount(long userId,
int type)
userId - the primary key of the usertype - the relation's type
public SocialRelation getRelation(long relationId)
throws PortalException
relationId - the primary key of the relation
PortalException
public SocialRelation getRelation(long userId1,
long userId2,
int type)
throws PortalException
userId1 - the user that is the subject of the relationuserId2 - the user at the other end of the relationtype - the relation's type
PortalException
public List<SocialRelation> getRelations(long userId,
int type,
int start,
int end)
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
userId - the primary key of the usertype - the relation's typestart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
public List<SocialRelation> getRelations(long userId1,
long userId2,
int start,
int end)
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil.ALL_POS will return the full
result set.
userId1 - the user that is the subject of the relationuserId2 - the user at the other end of the relationstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
public int getRelationsCount(long userId,
int type)
userId - the primary key of the usertype - the relation's type
public int getRelationsCount(long userId1,
long userId2)
userId1 - the user that is the subject of the relationuserId2 - the user at the other end of the relation
public boolean hasRelation(long userId1,
long userId2,
int type)
true if a relation of the given type exists where
the user with primary key userId1 is User1 of the relation
and the user with the primary key userId2 is User2 of the
relation.
userId1 - the user that is the subject of the relationuserId2 - the user at the other end of the relationtype - the relation's type
true if the relation exists; false
otherwise
public boolean isRelatable(long userId1,
long userId2,
int type)
true if the users can be in a relation of the given
type where the user with primary key userId1 is User1 of the
relation and the user with the primary key userId2 is User2
of the relation.
This method returns false if User1 and User2 are the same,
if either user is the default user, or if a matching relation already
exists.
userId1 - the user that is the subject of the relationuserId2 - the user at the other end of the relationtype - the relation's type
true if the two users can be in a new relation of
the given type; false otherwise
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||