Class SocialRelationLocalServiceUtil
com.liferay.portlet.social.service.impl.SocialRelationLocalServiceImpl
and
is an access point for service operations in application layer code running
on the local server. 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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic 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 PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static SocialRelation
createSocialRelation
(long relationId) Creates a new social relation with the primary key.static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) 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 <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuery
static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.static long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static SocialRelation
fetchSocialRelation
(long relationId) static SocialRelation
fetchSocialRelationByUuidAndCompanyId
(String uuid, long companyId) Returns the social relation with the matching UUID and company.static ActionableDynamicQuery
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 String
Returns the OSGi service identifier.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
static SocialRelation
getSocialRelation
(long relationId) Returns the social relation with the primary key.static SocialRelation
getSocialRelationByUuidAndCompanyId
(String uuid, long companyId) Returns the social relation with the matching UUID and company.static List<SocialRelation>
getSocialRelations
(int start, int end) Returns a range of all the social relations.static int
Returns the number of social relations.static boolean
hasRelation
(long userId1, long userId2, int type) Returnstrue
if a relation of the given type exists where the user with primary keyuserId1
is User1 of the relation and the user with the primary keyuserId2
is User2 of the relation.static boolean
isRelatable
(long userId1, long userId2, int type) Returnstrue
if the users can be in a relation of the given type where the user with primary keyuserId1
is User1 of the relation and the user with the primary keyuserId2
is User2 of the relation.static void
setService
(SocialRelationLocalService service) static SocialRelation
updateSocialRelation
(SocialRelation socialRelation) Updates the social relation in the database or adds it if it does not yet exist.
-
Constructor Details
-
SocialRelationLocalServiceUtil
public SocialRelationLocalServiceUtil()
-
-
Method Details
-
addRelation
public static SocialRelation addRelation(long userId1, long userId2, int type) throws PortalException Adds a social relation between the two users to the database.- Parameters:
userId1
- the user that is the subject of the relationuserId2
- the user at the other end of the relationtype
- the type of the relation- Returns:
- the social relation
- Throws:
PortalException
-
addSocialRelation
Adds the social relation to the database. Also notifies the appropriate model listeners.Important: Inspect SocialRelationLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
socialRelation
- the social relation- Returns:
- the social relation that was added
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
createSocialRelation
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
-
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
deleteRelation
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
-
deleteRelation
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 relationuserId2
- the user at the other end of the relationtype
- the relation's type- Throws:
PortalException
-
deleteRelation
Removes the relation (and its inverse in case of a bidirectional relation) from the database.- Parameters:
relation
- the relation to be removed- Throws:
PortalException
-
deleteRelations
public static void deleteRelations(long userId) Removes all relations involving the user from the database.- Parameters:
userId
- the primary key of the user
-
deleteRelations
Removes all relations between User1 and User2.- Parameters:
userId1
- the user that is the subject of the relationuserId2
- the user at the other end of the relation- Throws:
PortalException
-
deleteSocialRelation
Deletes the social relation with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect SocialRelationLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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
-
deleteSocialRelation
Deletes the social relation from the database. Also notifies the appropriate model listeners.Important: Inspect SocialRelationLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
socialRelation
- the social relation- Returns:
- the social relation that was removed
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.social.model.impl.SocialRelationModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.social.model.impl.SocialRelationModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchSocialRelation
-
fetchSocialRelationByUuidAndCompanyId
Returns the social relation with the matching UUID and company.- Parameters:
uuid
- the social relation's UUIDcompanyId
- the primary key of the company- Returns:
- the matching social relation, or
null
if a matching social relation could not be found
-
getActionableDynamicQuery
-
getIndexableActionableDynamicQuery
-
getInverseRelations
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil.ALL_POS
will return the full result set.- Parameters:
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)- Returns:
- the range of matching relations
-
getInverseRelationsCount
public 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.- Parameters:
userId
- the primary key of the usertype
- the relation's type- Returns:
- the number of matching relations
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getRelation
Returns the relation identified by its primary key.- Parameters:
relationId
- the primary key of the relation- Returns:
- Returns the relation
- Throws:
PortalException
-
getRelation
public static SocialRelation getRelation(long userId1, long userId2, int type) throws PortalException Returns the relation of the given type between User1 and User2.- Parameters:
userId1
- the user that is the subject of the relationuserId2
- the user at the other end of the relationtype
- the relation's type- Returns:
- Returns the relation
- Throws:
PortalException
-
getRelations
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil.ALL_POS
will return the full result set.- Parameters:
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)- Returns:
- the range of relations
-
getRelations
Returns a range of all the relations between User1 and User2.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil.ALL_POS
will return the full result set.- Parameters:
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)- Returns:
- the range of relations
-
getRelationsCount
public 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.- Parameters:
userId
- the primary key of the usertype
- the relation's type- Returns:
- the number of relations
-
getRelationsCount
public static int getRelationsCount(long userId1, long userId2) Returns the number of relations between User1 and User2.- Parameters:
userId1
- the user that is the subject of the relationuserId2
- the user at the other end of the relation- Returns:
- the number of relations
-
getSocialRelation
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
-
getSocialRelationByUuidAndCompanyId
public static SocialRelation getSocialRelationByUuidAndCompanyId(String uuid, long companyId) throws PortalException Returns the social relation with the matching UUID and company.- Parameters:
uuid
- the social relation's UUIDcompanyId
- the primary key of the company- Returns:
- the matching social relation
- Throws:
PortalException
- if a matching social relation could not be found
-
getSocialRelations
Returns a range of all the social relations.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.social.model.impl.SocialRelationModelImpl
.- Parameters:
start
- the lower bound of the range of social relationsend
- the upper bound of the range of social relations (not inclusive)- Returns:
- the range of social relations
-
getSocialRelationsCount
public static int getSocialRelationsCount()Returns the number of social relations.- Returns:
- the number of social relations
-
hasRelation
public static boolean hasRelation(long userId1, long userId2, int type) Returnstrue
if a relation of the given type exists where the user with primary keyuserId1
is User1 of the relation and the user with the primary keyuserId2
is User2 of the relation.- Parameters:
userId1
- the user that is the subject of the relationuserId2
- the user at the other end of the relationtype
- the relation's type- Returns:
true
if the relation exists;false
otherwise
-
isRelatable
public static boolean isRelatable(long userId1, long userId2, int type) Returnstrue
if the users can be in a relation of the given type where the user with primary keyuserId1
is User1 of the relation and the user with the primary keyuserId2
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 relationuserId2
- the user at the other end of the relationtype
- the relation's type- Returns:
true
if the two users can be in a new relation of the given type;false
otherwise
-
updateSocialRelation
Updates the social relation in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect SocialRelationLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
socialRelation
- the social relation- Returns:
- the social relation that was updated
-
getService
-
setService
-