Class AccountRoleLocalServiceUtil

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

public class AccountRoleLocalServiceUtil extends Object
Provides the local service utility for AccountRole. This utility wraps com.liferay.account.service.impl.AccountRoleLocalServiceImpl 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

    • AccountRoleLocalServiceUtil

      public AccountRoleLocalServiceUtil()
  • Method Details

    • addAccountRole

      public static AccountRole addAccountRole(AccountRole accountRole)
      Adds the account role to the database. Also notifies the appropriate model listeners.

      Important: Inspect AccountRoleLocalServiceImpl 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:
      accountRole - the account role
      Returns:
      the account role that was added
    • addAccountRole

      public static AccountRole addAccountRole(String externalReferenceCode, long userId, long accountEntryId, String name, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • associateUser

      public static void associateUser(long accountEntryId, long accountRoleId, long userId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • associateUser

      public static void associateUser(long accountEntryId, long[] accountRoleIds, long userId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createAccountRole

      public static AccountRole createAccountRole(long accountRoleId)
      Creates a new account role with the primary key. Does not add the account role to the database.
      Parameters:
      accountRoleId - the primary key for the new account role
      Returns:
      the new account role
    • 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
    • deleteAccountRole

      public static AccountRole deleteAccountRole(AccountRole accountRole) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the account role from the database. Also notifies the appropriate model listeners.

      Important: Inspect AccountRoleLocalServiceImpl 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:
      accountRole - the account role
      Returns:
      the account role that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteAccountRole

      public static AccountRole deleteAccountRole(long accountRoleId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the account role with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect AccountRoleLocalServiceImpl 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:
      accountRoleId - the primary key of the account role
      Returns:
      the account role that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a account role with the primary key could not be found
    • deleteAccountRolesByCompanyId

      public static void deleteAccountRolesByCompanyId(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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.AccountRoleModelImpl.

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

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

      public static AccountRole fetchAccountRole(long accountRoleId)
    • fetchAccountRoleByExternalReferenceCode

      public static AccountRole fetchAccountRoleByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchAccountRoleByRoleId

      public static AccountRole fetchAccountRoleByRoleId(long roleId)
    • getAccountRole

      public static AccountRole getAccountRole(long accountRoleId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the account role with the primary key.
      Parameters:
      accountRoleId - the primary key of the account role
      Returns:
      the account role
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a account role with the primary key could not be found
    • getAccountRoleByExternalReferenceCode

      public static AccountRole getAccountRoleByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getAccountRoleByRoleId

      public static AccountRole getAccountRoleByRoleId(long roleId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getAccountRoles

      public static List<AccountRole> getAccountRoles(int start, int end)
      Returns a range of all the account roles.

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

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

      public static List<AccountRole> getAccountRoles(long accountEntryId, long userId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getAccountRolesByAccountEntryIds

      public static List<AccountRole> getAccountRolesByAccountEntryIds(long companyId, long[] accountEntryIds)
    • getAccountRolesByAccountEntryIds

      public static List<AccountRole> getAccountRolesByAccountEntryIds(long[] accountEntryIds)
    • getAccountRolesCount

      public static int getAccountRolesCount()
      Returns the number of account roles.
      Returns:
      the number of account roles
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • 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
    • hasUserAccountRole

      public static boolean hasUserAccountRole(long accountEntryId, long accountRoleId, long userId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchAccountRoles

      public static com.liferay.portal.kernel.search.BaseModelSearchResult<AccountRole> searchAccountRoles(long companyId, long[] accountEntryIds, String keywords, LinkedHashMap<String,Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<?> orderByComparator)
    • setUserAccountRoles

      public static void setUserAccountRoles(long accountEntryId, long[] accountRoleIds, long userId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unassociateUser

      public static void unassociateUser(long accountEntryId, long accountRoleId, long userId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateAccountRole

      public static AccountRole updateAccountRole(AccountRole accountRole)
      Updates the account role in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect AccountRoleLocalServiceImpl 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:
      accountRole - the account role
      Returns:
      the account role that was updated
    • getService

      public static AccountRoleLocalService getService()