Class MBBanLocalServiceUtil

java.lang.Object
com.liferay.message.boards.service.MBBanLocalServiceUtil

public class MBBanLocalServiceUtil extends Object
Provides the local service utility for MBBan. This utility wraps com.liferay.message.boards.service.impl.MBBanLocalServiceImpl 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.
See Also:
Generated:
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static MBBan
    addBan(long userId, long banUserId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    static MBBan
    addMBBan(MBBan mbBan)
    Adds the message boards ban to the database.
    static void
    checkBan(long groupId, long banUserId)
     
    static MBBan
    createMBBan(long banId)
    Creates a new message boards ban with the primary key.
    static com.liferay.portal.kernel.model.PersistedModel
     
    static void
    deleteBan(long banId)
     
    static void
    deleteBan(long banUserId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    static void
     
    static void
    deleteBansByBanUserId(long banUserId)
     
    static void
    deleteBansByGroupId(long groupId)
     
    static MBBan
    deleteMBBan(long banId)
    Deletes the message boards ban with the primary key from the database.
    static MBBan
    Deletes the message boards ban from the database.
    static com.liferay.portal.kernel.model.PersistedModel
    deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
     
    static <T> T
    dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
     
    static int
    dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
     
    static com.liferay.portal.kernel.dao.orm.DynamicQuery
     
    static <T> List<T>
    dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
    Performs a dynamic query on the database and returns the matching rows.
    static <T> List<T>
    dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
    Performs a dynamic query on the database and returns an ordered range of the matching rows.
    static long
    dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
    Returns the number of rows matching the dynamic query.
    static long
    dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
    Returns the number of rows matching the dynamic query.
    static void
     
    static MBBan
    fetchMBBan(long banId)
     
    static MBBan
    fetchMBBanByUuidAndGroupId(String uuid, long groupId)
    Returns the message boards ban matching the UUID and group.
    static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
     
    static List<MBBan>
    getBans(long groupId, int start, int end)
     
    static int
    getBansCount(long groupId)
     
    static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
    getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
     
    static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
     
    static MBBan
    getMBBan(long banId)
    Returns the message boards ban with the primary key.
    static MBBan
    getMBBanByUuidAndGroupId(String uuid, long groupId)
    Returns the message boards ban matching the UUID and group.
    static List<MBBan>
    getMBBans(int start, int end)
    Returns a range of all the message boards bans.
    static List<MBBan>
    getMBBansByUuidAndCompanyId(String uuid, long companyId)
    Returns all the message boards bans matching the UUID and company.
    static List<MBBan>
    getMBBansByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<MBBan> orderByComparator)
    Returns a range of message boards bans matching the UUID and company.
    static int
    Returns the number of message boards bans.
    static String
    Returns the OSGi service identifier.
    static com.liferay.portal.kernel.model.PersistedModel
     
     
    static boolean
    hasBan(long groupId, long banUserId)
     
    static MBBan
    Updates the message boards ban in the database or adds it if it does not yet exist.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • MBBanLocalServiceUtil

      public MBBanLocalServiceUtil()
  • Method Details

    • addBan

      public static MBBan addBan(long userId, long banUserId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addMBBan

      public static MBBan addMBBan(MBBan mbBan)
      Adds the message boards ban to the database. Also notifies the appropriate model listeners.

      Important: Inspect MBBanLocalServiceImpl 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:
      mbBan - the message boards ban
      Returns:
      the message boards ban that was added
    • checkBan

      public static void checkBan(long groupId, long banUserId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createMBBan

      public static MBBan createMBBan(long banId)
      Creates a new message boards ban with the primary key. Does not add the message boards ban to the database.
      Parameters:
      banId - the primary key for the new message boards ban
      Returns:
      the new message boards ban
    • createPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteBan

      public static void deleteBan(long banId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteBan

      public static void deleteBan(long banUserId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    • deleteBan

      public static void deleteBan(MBBan ban)
    • deleteBansByBanUserId

      public static void deleteBansByBanUserId(long banUserId)
    • deleteBansByGroupId

      public static void deleteBansByGroupId(long groupId)
    • deleteMBBan

      public static MBBan deleteMBBan(long banId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the message boards ban with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect MBBanLocalServiceImpl 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:
      banId - the primary key of the message boards ban
      Returns:
      the message boards ban that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a message boards ban with the primary key could not be found
    • deleteMBBan

      public static MBBan deleteMBBan(MBBan mbBan)
      Deletes the message boards ban from the database. Also notifies the appropriate model listeners.

      Important: Inspect MBBanLocalServiceImpl 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:
      mbBan - the message boards ban
      Returns:
      the message boards ban that was removed
    • deletePersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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.message.boards.model.impl.MBBanModelImpl.

      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

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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.message.boards.model.impl.MBBanModelImpl.

      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

      public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.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

      public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.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
    • expireBans

      public static void expireBans()
    • fetchMBBan

      public static MBBan fetchMBBan(long banId)
    • fetchMBBanByUuidAndGroupId

      public static MBBan fetchMBBanByUuidAndGroupId(String uuid, long groupId)
      Returns the message boards ban matching the UUID and group.
      Parameters:
      uuid - the message boards ban's UUID
      groupId - the primary key of the group
      Returns:
      the matching message boards ban, or null if a matching message boards ban could not be found
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getBans

      public static List<MBBan> getBans(long groupId, int start, int end)
    • getBansCount

      public static int getBansCount(long groupId)
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getMBBan

      public static MBBan getMBBan(long banId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the message boards ban with the primary key.
      Parameters:
      banId - the primary key of the message boards ban
      Returns:
      the message boards ban
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a message boards ban with the primary key could not be found
    • getMBBanByUuidAndGroupId

      public static MBBan getMBBanByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the message boards ban matching the UUID and group.
      Parameters:
      uuid - the message boards ban's UUID
      groupId - the primary key of the group
      Returns:
      the matching message boards ban
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching message boards ban could not be found
    • getMBBans

      public static List<MBBan> getMBBans(int start, int end)
      Returns a range of all the message boards bans.

      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.message.boards.model.impl.MBBanModelImpl.

      Parameters:
      start - the lower bound of the range of message boards bans
      end - the upper bound of the range of message boards bans (not inclusive)
      Returns:
      the range of message boards bans
    • getMBBansByUuidAndCompanyId

      public static List<MBBan> getMBBansByUuidAndCompanyId(String uuid, long companyId)
      Returns all the message boards bans matching the UUID and company.
      Parameters:
      uuid - the UUID of the message boards bans
      companyId - the primary key of the company
      Returns:
      the matching message boards bans, or an empty list if no matches were found
    • getMBBansByUuidAndCompanyId

      public static List<MBBan> getMBBansByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<MBBan> orderByComparator)
      Returns a range of message boards bans matching the UUID and company.
      Parameters:
      uuid - the UUID of the message boards bans
      companyId - the primary key of the company
      start - the lower bound of the range of message boards bans
      end - the upper bound of the range of message boards bans (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching message boards bans, or an empty list if no matches were found
    • getMBBansCount

      public static int getMBBansCount()
      Returns the number of message boards bans.
      Returns:
      the number of message boards bans
    • getOSGiServiceIdentifier

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

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • hasBan

      public static boolean hasBan(long groupId, long banUserId)
    • updateMBBan

      public static MBBan updateMBBan(MBBan mbBan)
      Updates the message boards ban in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect MBBanLocalServiceImpl 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:
      mbBan - the message boards ban
      Returns:
      the message boards ban that was updated
    • getService

      public static MBBanLocalService getService()