Interface SocialRelationLocalService

All Superinterfaces:
BaseLocalService, CTService<SocialRelation>, PersistedModelLocalService
All Known Implementing Classes:
SocialRelationLocalServiceWrapper

Provides the local service interface for SocialRelation. 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}
  • Method Details

    • addRelation

      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 relation
      userId2 - the user at the other end of the relation
      type - the type of the relation
      Returns:
      the social relation
      Throws:
      PortalException
    • addSocialRelation

      @Indexable(type=REINDEX) SocialRelation addSocialRelation(SocialRelation socialRelation)
      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

      PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      createPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • createSocialRelation

      @Transactional(enabled=false) 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
    • deletePersistedModel

      PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Specified by:
      deletePersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • deleteRelation

      void deleteRelation(long relationId) throws PortalException
      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

      void deleteRelation(long userId1, long userId2, int type) throws PortalException
      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
    • deleteRelation

      void deleteRelation(SocialRelation relation) throws PortalException
      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

      void deleteRelations(long userId)
      Removes all relations involving the user from the database.
      Parameters:
      userId - the primary key of the user
    • deleteRelations

      void deleteRelations(long userId1, long userId2) throws PortalException
      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
    • deleteSocialRelation

      @Indexable(type=DELETE) SocialRelation deleteSocialRelation(long relationId) throws PortalException
      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

      @Indexable(type=DELETE) SocialRelation deleteSocialRelation(SocialRelation socialRelation)
      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

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface PersistedModelLocalService
    • dynamicQuery

    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

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

      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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portlet.social.model.impl.SocialRelationModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portlet.social.model.impl.SocialRelationModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchSocialRelation

      @Transactional(propagation=SUPPORTS, readOnly=true) SocialRelation fetchSocialRelation(long relationId)
    • fetchSocialRelationByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) SocialRelation fetchSocialRelationByUuidAndCompanyId(String uuid, long companyId)
      Returns the social relation with the matching UUID and company.
      Parameters:
      uuid - the social relation's UUID
      companyId - the primary key of the company
      Returns:
      the matching social relation, or null if a matching social relation could not be found
    • getActionableDynamicQuery

    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getInverseRelations

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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 user
      type - the relation's type
      Returns:
      the number of matching relations
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

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

      @Transactional(propagation=SUPPORTS, readOnly=true) SocialRelation getRelation(long relationId) throws PortalException
      Returns the relation identified by its primary key.
      Parameters:
      relationId - the primary key of the relation
      Returns:
      Returns the relation
      Throws:
      PortalException
    • getRelation

      @Transactional(propagation=SUPPORTS, readOnly=true) 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 relation
      userId2 - the user at the other end of the relation
      type - the relation's type
      Returns:
      Returns the relation
      Throws:
      PortalException
    • getRelations

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SocialRelation> getRelations(long userId1, long userId2, int start, int end)
      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
    • getRelationsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) 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 user
      type - the relation's type
      Returns:
      the number of relations
    • getRelationsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) 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 relation
      userId2 - the user at the other end of the relation
      Returns:
      the number of relations
    • getSocialRelation

      @Transactional(propagation=SUPPORTS, readOnly=true) SocialRelation getSocialRelation(long relationId) throws PortalException
      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

      @Transactional(propagation=SUPPORTS, readOnly=true) SocialRelation getSocialRelationByUuidAndCompanyId(String uuid, long companyId) throws PortalException
      Returns the social relation with the matching UUID and company.
      Parameters:
      uuid - the social relation's UUID
      companyId - the primary key of the company
      Returns:
      the matching social relation
      Throws:
      PortalException - if a matching social relation could not be found
    • getSocialRelations

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SocialRelation> getSocialRelations(int start, int end)
      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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portlet.social.model.impl.SocialRelationModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getSocialRelationsCount()
      Returns the number of social relations.
      Returns:
      the number of social relations
    • hasRelation

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

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

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

      @Indexable(type=REINDEX) SocialRelation updateSocialRelation(SocialRelation socialRelation)
      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
    • getCTPersistence

      Specified by:
      getCTPersistence in interface CTService<SocialRelation>
    • getModelClass

      @Transactional(enabled=false) Class<SocialRelation> getModelClass()
      Specified by:
      getModelClass in interface CTService<SocialRelation>
    • updateWithUnsafeFunction

      @Transactional(rollbackFor=java.lang.Throwable.class) <R, E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<SocialRelation>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface CTService<SocialRelation>
      Throws:
      E extends Throwable