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 SocialRelationLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to SocialRelationLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

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, SocialRelationLocalServiceBaseImpl, SocialRelationLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary

SocialRelationLocalServiceUtil()

Method Summary

static SocialRelation	addRelation(long userId1, long userId2, int type)
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)
static void	deleteRelation(long userId1, long userId2, int type)
static void	deleteRelation(SocialRelation relation)
static void	deleteRelations(long userId)
static void	deleteSocialRelation(long relationId) Deletes the social relation with the primary key from the database.
static void	deleteSocialRelation(SocialRelation socialRelation) Deletes the social relation from the database.
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) Counts the number of rows that match the dynamic query.
static SocialRelation	getRelation(long relationId)
static SocialRelation	getRelation(long userId1, long userId2, int type)
static List<SocialRelation>	getRelations(long userId, int type, int start, int end)
static int	getRelationsCount(long userId, int type)
static SocialRelationLocalService	getService()
static SocialRelation	getSocialRelation(long relationId) Gets the social relation with the primary key.
static List<SocialRelation>	getSocialRelations(int start, int end) Gets a range of all the social relations.
static int	getSocialRelationsCount() Gets the number of social relations.
static boolean	hasRelation(long userId1, long userId2, int type)
static boolean	isRelatable(long userId1, long userId2, int type)
void	setService(SocialRelationLocalService service)
static SocialRelation	updateSocialRelation(SocialRelation socialRelation) Updates the social relation in the database.
static SocialRelation	updateSocialRelation(SocialRelation socialRelation, boolean merge) Updates the social relation in the database.

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 to add

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 void 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 to delete

Throws:

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

SystemException - if a system exception occurred

deleteSocialRelation

public static void deleteSocialRelation(SocialRelation socialRelation)
                                 throws SystemException

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

Parameters:

socialRelation - the social relation to delete

Throws:

SystemException - if a system exception occurred

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 to search with

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 to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (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 to search with

start - the lower bound of the range of model instances to return

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

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getSocialRelation

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

Gets the social relation with the primary key.

Parameters:

relationId - the primary key of the social relation to get

Returns:

the social relation

Throws:

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

SystemException - if a system exception occurred

getSocialRelations

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

Gets 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 to return

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

Returns:

the range of social relations

Throws:

SystemException - if a system exception occurred

getSocialRelationsCount

public static int getSocialRelationsCount()
                                   throws SystemException

Gets 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. Also notifies the appropriate model listeners.

Parameters:

socialRelation - the social relation to update

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. Also notifies the appropriate model listeners.

Parameters:

socialRelation - the social relation to update

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

addRelation

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

Throws:

PortalException

SystemException

deleteRelation

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

Throws:

PortalException

SystemException

deleteRelation

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

Throws:

PortalException

SystemException

deleteRelation

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

Throws:

PortalException

SystemException

deleteRelations

public static void deleteRelations(long userId)
                            throws SystemException

Throws:

SystemException

getRelation

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

Throws:

PortalException

SystemException

getRelation

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

Throws:

PortalException

SystemException

getRelations

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

Throws:

SystemException

getRelationsCount

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

Throws:

SystemException

hasRelation

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

Throws:

SystemException

isRelatable

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

Throws:

SystemException

getService

public static SocialRelationLocalService getService()

setService

public void setService(SocialRelationLocalService service)