com.liferay.portlet.social.service
Interface SocialRelationLocalService

All Known Implementing Classes:

SocialRelationLocalServiceBaseImpl, SocialRelationLocalServiceImpl, SocialRelationLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface SocialRelationLocalService

The interface for the social relation local service.

Never modify or reference this interface directly. Always use SocialRelationLocalServiceUtil to access the social relation local service. Add custom service methods to SocialRelationLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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:

SocialRelationLocalServiceUtil, SocialRelationLocalServiceBaseImpl, SocialRelationLocalServiceImpl

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

Method Summary

SocialRelation	addRelation(long userId1, long userId2, int type)
SocialRelation	addSocialRelation(SocialRelation socialRelation) Adds the social relation to the database.
SocialRelation	createSocialRelation(long relationId) Creates a new social relation with the primary key.
void	deleteRelation(long relationId)
void	deleteRelation(long userId1, long userId2, int type)
void	deleteRelation(SocialRelation relation)
void	deleteRelations(long userId)
void	deleteSocialRelation(long relationId) Deletes the social relation with the primary key from the database.
void	deleteSocialRelation(SocialRelation socialRelation) Deletes the social relation from the database.
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
SocialRelation	getRelation(long relationId)
SocialRelation	getRelation(long userId1, long userId2, int type)
List<SocialRelation>	getRelations(long userId, int type, int start, int end)
int	getRelationsCount(long userId, int type)
SocialRelation	getSocialRelation(long relationId) Gets the social relation with the primary key.
List<SocialRelation>	getSocialRelations(int start, int end) Gets a range of all the social relations.
int	getSocialRelationsCount() Gets the number of social relations.
boolean	hasRelation(long userId1, long userId2, int type)
boolean	isRelatable(long userId1, long userId2, int type)
SocialRelation	updateSocialRelation(SocialRelation socialRelation) Updates the social relation in the database.
SocialRelation	updateSocialRelation(SocialRelation socialRelation, boolean merge) Updates the social relation in the database.

Method Detail

addSocialRelation

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

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

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

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

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

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSocialRelationsCount()
                            throws SystemException

Gets the number of social relations.

Returns:

the number of social relations

Throws:

SystemException - if a system exception occurred

updateSocialRelation

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

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

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

Throws:

PortalException

SystemException

deleteRelation

void deleteRelation(long relationId)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

deleteRelation

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

Throws:

PortalException

SystemException

deleteRelation

void deleteRelation(SocialRelation relation)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

deleteRelations

void deleteRelations(long userId)
                     throws SystemException

Throws:

SystemException

getRelation

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialRelation getRelation(long relationId)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getRelation

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialRelation getRelation(long userId1,
                                                                    long userId2,
                                                                    int type)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getRelations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialRelation> getRelations(long userId,
                                                                           int type,
                                                                           int start,
                                                                           int end)
                                  throws SystemException

Throws:

SystemException

getRelationsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRelationsCount(long userId,
                                                               int type)
                      throws SystemException

Throws:

SystemException

hasRelation

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasRelation(long userId1,
                                                             long userId2,
                                                             int type)
                    throws SystemException

Throws:

SystemException

isRelatable

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isRelatable(long userId1,
                                                             long userId2,
                                                             int type)
                    throws SystemException

Throws:

SystemException