com.liferay.portlet.social.service
Class SocialRelationLocalServiceUtil

java.lang.Object
  com.liferay.portlet.social.service.SocialRelationLocalServiceUtil

public class SocialRelationLocalServiceUtil
extends Object

The utility for the social relation local service. This utility wraps com.liferay.portlet.social.service.impl.SocialRelationLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

SocialRelationLocalService, com.liferay.portlet.social.service.base.SocialRelationLocalServiceBaseImpl, com.liferay.portlet.social.service.impl.SocialRelationLocalServiceImpl

Constructor Summary

SocialRelationLocalServiceUtil()

Method Summary

static SocialRelation	addRelation(long userId1, long userId2, int type) Adds a social relation between the two users to the database.
static SocialRelation	addSocialRelation(SocialRelation socialRelation) Adds the social relation to the database.
static SocialRelation	createSocialRelation(long relationId) Creates a new social relation with the primary key.
static void	deleteRelation(long relationId) Removes the relation (and its inverse in case of a bidirectional relation) from the database.
static void	deleteRelation(long userId1, long userId2, int type) Removes the matching relation (and its inverse in case of a bidirectional relation) from the database.
static void	deleteRelation(SocialRelation relation) Removes the relation (and its inverse in case of a bidirectional relation) from the database.
static void	deleteRelations(long userId) Removes all relations involving the user from the database.
static void	deleteRelations(long userId1, long userId2) Removes all relations between User1 and User2.
static SocialRelation	deleteSocialRelation(long relationId) Deletes the social relation with the primary key from the database.
static SocialRelation	deleteSocialRelation(SocialRelation socialRelation) Deletes the social relation from the database.
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static SocialRelation	fetchSocialRelation(long relationId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static 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.
static 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.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static SocialRelation	getRelation(long relationId) Returns the relation identified by its primary key.
static SocialRelation	getRelation(long userId1, long userId2, int type) Returns the relation of the given type between User1 and User2.
static 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.
static List<SocialRelation>	getRelations(long userId1, long userId2, int start, int end) Returns a range of all the relations between User1 and User2.
static int	getRelationsCount(long userId, int type) Returns the number of relations of the given type where the user is the subject of the relation.
static int	getRelationsCount(long userId1, long userId2) Returns the number of relations between User1 and User2.
static SocialRelationLocalService	getService()
static SocialRelation	getSocialRelation(long relationId) Returns the social relation with the primary key.
static List<SocialRelation>	getSocialRelations(int start, int end) Returns a range of all the social relations.
static int	getSocialRelationsCount() Returns the number of social relations.
static 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.
static 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.
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(SocialRelationLocalService service) Deprecated.
static SocialRelation	updateSocialRelation(SocialRelation socialRelation) Updates the social relation in the database or adds it if it does not yet exist.
static SocialRelation	updateSocialRelation(SocialRelation socialRelation, boolean merge) Updates the social relation in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

SocialRelationLocalServiceUtil

public SocialRelationLocalServiceUtil()

Method Detail

addSocialRelation

public static SocialRelation addSocialRelation(SocialRelation socialRelation)
                                        throws SystemException

Adds the social relation to the database. Also notifies the appropriate model listeners.

Parameters:

socialRelation - the social relation

Returns:

the social relation that was added

Throws:

SystemException - if a system exception occurred

createSocialRelation

public static SocialRelation createSocialRelation(long relationId)

Creates a new social relation with the primary key. Does not add the social relation to the database.

Parameters:

relationId - the primary key for the new social relation

Returns:

the new social relation

deleteSocialRelation

public static SocialRelation deleteSocialRelation(long relationId)
                                           throws PortalException,
                                                  SystemException

Deletes the social relation with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

relationId - the primary key of the social relation

Returns:

the social relation that was removed

Throws:

PortalException - if a social relation with the primary key could not be found

SystemException - if a system exception occurred

deleteSocialRelation

public static SocialRelation deleteSocialRelation(SocialRelation socialRelation)
                                           throws SystemException

Deletes the social relation from the database. Also notifies the appropriate model listeners.

Parameters:

socialRelation - the social relation

Returns:

the social relation that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchSocialRelation

public static SocialRelation fetchSocialRelation(long relationId)
                                          throws SystemException

Throws:

SystemException

getSocialRelation

public static SocialRelation getSocialRelation(long relationId)
                                        throws PortalException,
                                               SystemException

Returns the social relation with the primary key.

Parameters:

relationId - the primary key of the social relation

Returns:

the social relation

Throws:

PortalException - if a social relation with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getSocialRelations

public static List<SocialRelation> getSocialRelations(int start,
                                                      int end)
                                               throws SystemException

Returns a range of all the social relations.

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.

Parameters:

start - the lower bound of the range of social relations

end - the upper bound of the range of social relations (not inclusive)

Returns:

the range of social relations

Throws:

SystemException - if a system exception occurred

getSocialRelationsCount

public static int getSocialRelationsCount()
                                   throws SystemException

Returns the number of social relations.

Returns:

the number of social relations

Throws:

SystemException - if a system exception occurred

updateSocialRelation

public static SocialRelation updateSocialRelation(SocialRelation socialRelation)
                                           throws SystemException

Updates the social relation in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

socialRelation - the social relation

Returns:

the social relation that was updated

Throws:

SystemException - if a system exception occurred

updateSocialRelation

public static SocialRelation updateSocialRelation(SocialRelation socialRelation,
                                                  boolean merge)
                                           throws SystemException

Updates the social relation in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

socialRelation - the social relation

merge - whether to merge the social relation with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the social relation that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addRelation

public static SocialRelation addRelation(long userId1,
                                         long userId2,
                                         int type)
                                  throws PortalException,
                                         SystemException

Adds a social relation between the two users to the database.

Parameters:

userId1 - the user that is the subject of the relation

userId2 - the user at the other end of the relation

type - the type of the relation

Returns:

the social relation

Throws:

PortalException - if the users could not be found, if the users were not from the same company, or if either of the users was the default user

SystemException - if a system exception occurred

deleteRelation

public static void deleteRelation(long relationId)
                           throws PortalException,
                                  SystemException

Removes the relation (and its inverse in case of a bidirectional relation) from the database.

Parameters:

relationId - the primary key of the relation

Throws:

PortalException - if the relation could not be found

SystemException - if a system exception occurred

deleteRelation

public static void deleteRelation(long userId1,
                                  long userId2,
                                  int type)
                           throws PortalException,
                                  SystemException

Removes the matching relation (and its inverse in case of a bidirectional relation) from the database.

Parameters:

userId1 - the user that is the subject of the relation

userId2 - the user at the other end of the relation

type - the relation's type

Throws:

PortalException - if the relation or its inverse relation (if applicable) could not be found

SystemException - if a system exception occurred

deleteRelation

public static void deleteRelation(SocialRelation relation)
                           throws PortalException,
                                  SystemException

Removes the relation (and its inverse in case of a bidirectional relation) from the database.

Parameters:

relation - the relation to be removed

Throws:

PortalException - if the relation is bidirectional and its inverse relation could not be found

SystemException - if a system exception occurred

deleteRelations

public static void deleteRelations(long userId)
                            throws SystemException

Removes all relations involving the user from the database.

Parameters:

userId - the primary key of the user

Throws:

SystemException - if a system exception occurred

deleteRelations

public static void deleteRelations(long userId1,
                                   long userId2)
                            throws PortalException,
                                   SystemException

Removes all relations between User1 and User2.

Parameters:

userId1 - the user that is the subject of the relation

userId2 - the user at the other end of the relation

Throws:

PortalException - if the inverse relation could not be found

SystemException - if a system exception occurred

getInverseRelations

public static List<SocialRelation> getInverseRelations(long userId,
                                                       int type,
                                                       int start,
                                                       int end)
                                                throws SystemException

Returns a range of all the inverse relations of the given type for which the user is User2 of the relation.

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.

Parameters:

userId - the primary key of the user

type - the relation's type

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching relations

Throws:

SystemException - if a system exception occurred

getInverseRelationsCount

public static int getInverseRelationsCount(long userId,
                                           int type)
                                    throws SystemException

Returns the number of inverse relations of the given type for which the user is User2 of the relation.

Parameters:

userId - the primary key of the user

type - the relation's type

Returns:

the number of matching relations

Throws:

SystemException - if a system exception occurred

getRelation

public static SocialRelation getRelation(long relationId)
                                  throws PortalException,
                                         SystemException

Returns the relation identified by its primary key.

Parameters:

relationId - the primary key of the relation

Returns:

Returns the relation

Throws:

PortalException - if the relation could not be found

SystemException - if a system exception occurred

getRelation

public static SocialRelation getRelation(long userId1,
                                         long userId2,
                                         int type)
                                  throws PortalException,
                                         SystemException

Returns the relation of the given type between User1 and User2.

Parameters:

userId1 - the user that is the subject of the relation

userId2 - the user at the other end of the relation

type - the relation's type

Returns:

Returns the relation

Throws:

PortalException - if the relation could not be found

SystemException - if a system exception occurred

getRelations

public static List<SocialRelation> getRelations(long userId,
                                                int type,
                                                int start,
                                                int end)
                                         throws SystemException

Returns a range of all the relations of the given type where the user is the subject of the relation.

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.

Parameters:

userId - the primary key of the user

type - the relation's type

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of relations

Throws:

SystemException - if a system exception occurred

getRelations

public static List<SocialRelation> getRelations(long userId1,
                                                long userId2,
                                                int start,
                                                int end)
                                         throws SystemException

Returns a range of all the relations between User1 and User2.

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.

Parameters:

userId1 - the user that is the subject of the relation

userId2 - the user at the other end of the relation

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of relations

Throws:

SystemException - if a system exception occurred

getRelationsCount

public static int getRelationsCount(long userId,
                                    int type)
                             throws SystemException

Returns the number of relations of the given type where the user is the subject of the relation.

Parameters:

userId - the primary key of the user

type - the relation's type

Returns:

the number of relations

Throws:

SystemException - if a system exception occurred

getRelationsCount

public static int getRelationsCount(long userId1,
                                    long userId2)
                             throws SystemException

Returns the number of relations between User1 and User2.

Parameters:

userId1 - the user that is the subject of the relation

userId2 - the user at the other end of the relation

Returns:

the number of relations

Throws:

SystemException - if a system exception occurred

hasRelation

public static boolean hasRelation(long userId1,
                                  long userId2,
                                  int type)
                           throws SystemException

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.

Parameters:

userId1 - the user that is the subject of the relation

userId2 - the user at the other end of the relation

type - the relation's type

Returns:

true if the relation exists; false otherwise

Throws:

SystemException - if a system exception occurred

isRelatable

public static boolean isRelatable(long userId1,
                                  long userId2,
                                  int type)
                           throws SystemException

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.

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.

Parameters:

userId1 - the user that is the subject of the relation

userId2 - the user at the other end of the relation

type - the relation's type

Returns:

true if the two users can be in a new relation of the given type; false otherwise

Throws:

SystemException - if a system exception occurred

getService

public static SocialRelationLocalService getService()

setService

public void setService(SocialRelationLocalService service)

Deprecated.