Interface AccountRoleLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService
,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
AccountRoleLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddAccountRole
(AccountRole accountRole) Adds the account role to the database.addAccountRole
(String externalReferenceCode, long userId, long accountEntryId, String name, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap) void
associateUser
(long accountEntryId, long[] accountRoleIds, long userId) void
associateUser
(long accountEntryId, long accountRoleId, long userId) createAccountRole
(long accountRoleId) Creates a new account role with the primary key.com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) deleteAccountRole
(long accountRoleId) Deletes the account role with the primary key from the database.deleteAccountRole
(AccountRole accountRole) Deletes the account role from the database.void
deleteAccountRolesByCompanyId
(long companyId) com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery
<T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.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.fetchAccountRole
(long accountRoleId) fetchAccountRoleByExternalReferenceCode
(String externalReferenceCode, long companyId) fetchAccountRoleByRoleId
(long roleId) getAccountRole
(long accountRoleId) Returns the account role with the primary key.getAccountRoleByExternalReferenceCode
(String externalReferenceCode, long companyId) getAccountRoleByRoleId
(long roleId) getAccountRoles
(int start, int end) Returns a range of all the account roles.getAccountRoles
(long accountEntryId, long userId) getAccountRolesByAccountEntryIds
(long[] accountEntryIds) getAccountRolesByAccountEntryIds
(long companyId, long[] accountEntryIds) int
Returns the number of account roles.com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) boolean
hasUserAccountRole
(long accountEntryId, long accountRoleId, long userId) 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) void
setUserAccountRoles
(long accountEntryId, long[] accountRoleIds, long userId) void
unassociateUser
(long accountEntryId, long accountRoleId, long userId) updateAccountRole
(AccountRole accountRole) Updates the account role in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addAccountRole
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
AccountRole addAccountRole(String externalReferenceCode, long userId, long accountEntryId, String name, Map<Locale, String> titleMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
associateUser
void associateUser(long accountEntryId, long accountRoleId, long userId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
associateUser
void associateUser(long accountEntryId, long[] accountRoleIds, long userId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createAccountRole
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
com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteAccountRole
@Indexable(type=DELETE) 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
@Indexable(type=DELETE) 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
void deleteAccountRolesByCompanyId(long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deletePersistedModel
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deletePersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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
@Transactional(propagation=SUPPORTS, readOnly=true) <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
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.account.model.impl.AccountRoleModelImpl
.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) <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
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.account.model.impl.AccountRoleModelImpl
.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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 queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchAccountRole
@Transactional(propagation=SUPPORTS, readOnly=true) AccountRole fetchAccountRole(long accountRoleId) -
fetchAccountRoleByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) AccountRole fetchAccountRoleByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchAccountRoleByRoleId
@Transactional(propagation=SUPPORTS, readOnly=true) AccountRole fetchAccountRoleByRoleId(long roleId) -
getAccountRole
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) AccountRole getAccountRoleByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getAccountRoleByRoleId
@Transactional(propagation=SUPPORTS, readOnly=true) AccountRole getAccountRoleByRoleId(long roleId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getAccountRoles
@Transactional(propagation=SUPPORTS, readOnly=true) 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
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.account.model.impl.AccountRoleModelImpl
.- Parameters:
start
- the lower bound of the range of account rolesend
- the upper bound of the range of account roles (not inclusive)- Returns:
- the range of account roles
-
getAccountRoles
@Transactional(propagation=SUPPORTS, readOnly=true) List<AccountRole> getAccountRoles(long accountEntryId, long userId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getAccountRolesByAccountEntryIds
@Transactional(propagation=SUPPORTS, readOnly=true) List<AccountRole> getAccountRolesByAccountEntryIds(long companyId, long[] accountEntryIds) -
getAccountRolesByAccountEntryIds
@Transactional(propagation=SUPPORTS, readOnly=true) List<AccountRole> getAccountRolesByAccountEntryIds(long[] accountEntryIds) -
getAccountRolesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getAccountRolesCount()Returns the number of account roles.- Returns:
- the number of account roles
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
hasUserAccountRole
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserAccountRole(long accountEntryId, long accountRoleId, long userId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
searchAccountRoles
@Transactional(propagation=SUPPORTS, readOnly=true) 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
void setUserAccountRoles(long accountEntryId, long[] accountRoleIds, long userId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
unassociateUser
void unassociateUser(long accountEntryId, long accountRoleId, long userId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateAccountRole
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
-