Liferay 6.0-ee-sp2

com.liferay.portlet.social.service
Interface SocialRelationLocalService

All Superinterfaces:
PersistedModelLocalService
All Known Implementing Classes:
SocialRelationLocalServiceWrapper

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

The interface for the social relation local service.

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, com.liferay.portlet.social.service.base.SocialRelationLocalServiceBaseImpl, com.liferay.portlet.social.service.impl.SocialRelationLocalServiceImpl

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 deleteRelations(long userId1, long userId2)
           
 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)
          Returns the number of rows that match the dynamic query.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<SocialRelation> getInverseRelations(long userId, int type, int start, int end)
           
 int getInverseRelationsCount(long userId, int type)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 SocialRelation getRelation(long relationId)
           
 SocialRelation getRelation(long userId1, long userId2, int type)
           
 List<SocialRelation> getRelations(long userId, int type, int start, int end)
           
 List<SocialRelation> getRelations(long userId1, long userId2, int start, int end)
           
 int getRelationsCount(long userId, int type)
           
 int getRelationsCount(long userId1, long userId2)
           
 SocialRelation getSocialRelation(long relationId)
          Returns the social relation with the primary key.
 List<SocialRelation> getSocialRelations(int start, int end)
          Returns a range of all the social relations.
 int getSocialRelationsCount()
          Returns the number of social relations.
 boolean hasRelation(long userId1, long userId2, int type)
           
 boolean isRelatable(long userId1, long userId2, int type)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 SocialRelation updateSocialRelation(SocialRelation socialRelation)
          Updates the social relation in the database or adds it if it does not yet exist.
 SocialRelation updateSocialRelation(SocialRelation socialRelation, boolean merge)
          Updates the social relation in the database or adds it if it does not yet exist.
 

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

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

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

getSocialRelation

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getSocialRelations

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSocialRelationsCount()
                            throws SystemException
Returns 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 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

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

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

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

deleteRelations

void deleteRelations(long userId1,
                     long userId2)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

getInverseRelations

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

getInverseRelationsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getInverseRelationsCount(long userId,
                                                                      int type)
                             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

getRelations

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialRelation> getRelations(long userId1,
                                                                           long userId2,
                                                                           int start,
                                                                           int end)
                                  throws SystemException
Throws:
SystemException

getRelationsCount

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

getRelationsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRelationsCount(long userId1,
                                                               long userId2)
                      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

Liferay 6.0-ee-sp2