Class AccountGroupLocalServiceUtil

java.lang.Object
com.liferay.account.service.AccountGroupLocalServiceUtil

public class AccountGroupLocalServiceUtil extends Object
Provides the local service utility for AccountGroup. This utility wraps com.liferay.account.service.impl.AccountGroupLocalServiceImpl 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 Details

    • AccountGroupLocalServiceUtil

      public AccountGroupLocalServiceUtil()
  • Method Details

    • addAccountGroup

      public static AccountGroup addAccountGroup(AccountGroup accountGroup)
      Adds the account group to the database. Also notifies the appropriate model listeners.

      Important: Inspect AccountGroupLocalServiceImpl 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:
      accountGroup - the account group
      Returns:
      the account group that was added
    • addAccountGroup

      public static AccountGroup addAccountGroup(long userId, String description, String name, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • checkGuestAccountGroup

      public static AccountGroup checkGuestAccountGroup(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createAccountGroup

      public static AccountGroup createAccountGroup(long accountGroupId)
      Creates a new account group with the primary key. Does not add the account group to the database.
      Parameters:
      accountGroupId - the primary key for the new account group
      Returns:
      the new account group
    • 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
    • deleteAccountGroup

      public static AccountGroup deleteAccountGroup(AccountGroup accountGroup) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the account group from the database. Also notifies the appropriate model listeners.

      Important: Inspect AccountGroupLocalServiceImpl 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:
      accountGroup - the account group
      Returns:
      the account group that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteAccountGroup

      public static AccountGroup deleteAccountGroup(long accountGroupId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the account group with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect AccountGroupLocalServiceImpl 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:
      accountGroupId - the primary key of the account group
      Returns:
      the account group that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a account group with the primary key could not be found
    • 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.account.model.impl.AccountGroupModelImpl.

      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.account.model.impl.AccountGroupModelImpl.

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

      public static AccountGroup fetchAccountGroup(long accountGroupId)
    • fetchAccountGroupByExternalReferenceCode

      public static AccountGroup fetchAccountGroupByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchAccountGroupByUuidAndCompanyId

      public static AccountGroup fetchAccountGroupByUuidAndCompanyId(String uuid, long companyId)
      Returns the account group with the matching UUID and company.
      Parameters:
      uuid - the account group's UUID
      companyId - the primary key of the company
      Returns:
      the matching account group, or null if a matching account group could not be found
    • getAccountGroup

      public static AccountGroup getAccountGroup(long accountGroupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the account group with the primary key.
      Parameters:
      accountGroupId - the primary key of the account group
      Returns:
      the account group
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a account group with the primary key could not be found
    • getAccountGroupByExternalReferenceCode

      public static AccountGroup getAccountGroupByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getAccountGroupByUuidAndCompanyId

      public static AccountGroup getAccountGroupByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the account group with the matching UUID and company.
      Parameters:
      uuid - the account group's UUID
      companyId - the primary key of the company
      Returns:
      the matching account group
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching account group could not be found
    • getAccountGroupIds

      public static long[] getAccountGroupIds(long accountEntryId)
    • getAccountGroups

      public static List<AccountGroup> getAccountGroups(int start, int end)
      Returns a range of all the account groups.

      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.account.model.impl.AccountGroupModelImpl.

      Parameters:
      start - the lower bound of the range of account groups
      end - the upper bound of the range of account groups (not inclusive)
      Returns:
      the range of account groups
    • getAccountGroups

      public static List<AccountGroup> getAccountGroups(long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AccountGroup> orderByComparator)
    • getAccountGroups

      public static List<AccountGroup> getAccountGroups(long companyId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AccountGroup> orderByComparator)
    • getAccountGroupsByAccountEntryId

      public static List<AccountGroup> getAccountGroupsByAccountEntryId(long accountEntryId, int start, int end)
    • getAccountGroupsByAccountGroupId

      public static List<AccountGroup> getAccountGroupsByAccountGroupId(long[] accountGroupIds)
    • getAccountGroupsCount

      public static int getAccountGroupsCount()
      Returns the number of account groups.
      Returns:
      the number of account groups
    • getAccountGroupsCount

      public static int getAccountGroupsCount(long companyId)
    • getAccountGroupsCount

      public static long getAccountGroupsCount(long companyId, String name)
    • getAccountGroupsCountByAccountEntryId

      public static int getAccountGroupsCountByAccountEntryId(long accountEntryId)
    • getActionableDynamicQuery

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

      public static AccountGroup getDefaultAccountGroup(long companyId)
    • 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()
    • 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
    • hasDefaultAccountGroup

      public static boolean hasDefaultAccountGroup(long companyId)
    • searchAccountGroups

      public static com.liferay.portal.kernel.search.BaseModelSearchResult<AccountGroup> searchAccountGroups(long companyId, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AccountGroup> orderByComparator)
    • searchAccountGroups

      public static com.liferay.portal.kernel.search.BaseModelSearchResult<AccountGroup> searchAccountGroups(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<AccountGroup> orderByComparator)
    • updateAccountGroup

      public static AccountGroup updateAccountGroup(AccountGroup accountGroup)
      Updates the account group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect AccountGroupLocalServiceImpl 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:
      accountGroup - the account group
      Returns:
      the account group that was updated
    • updateAccountGroup

      public static AccountGroup updateAccountGroup(long accountGroupId, String description, String name, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateExternalReferenceCode

      public static AccountGroup updateExternalReferenceCode(AccountGroup accountGroup, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateExternalReferenceCode

      public static AccountGroup updateExternalReferenceCode(long accountGroupId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static AccountGroupLocalService getService()