com.liferay.account.service

Interface AccountRoleLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

AccountRoleLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface AccountRoleLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for AccountRole. 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:

AccountRoleLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
AccountRole	addAccountRole(AccountRole accountRole) Adds the account role to the database.
AccountRole	addAccountRole(long userId, long accountEntryId, java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap)
void	associateUser(long accountEntryId, long accountRoleId, long userId)
AccountRole	createAccountRole(long accountRoleId) Creates a new account role with the primary key.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
AccountRole	deleteAccountRole(AccountRole accountRole) Deletes the account role from the database.
AccountRole	deleteAccountRole(long accountRoleId) Deletes the account role with the primary key from the database.
void	deleteAccountRolesByCompanyId(long companyId)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
<T> T	dslQuery(DSLQuery dslQuery)
DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
AccountRole	fetchAccountRole(long accountRoleId)
AccountRole	fetchAccountRoleByRoleId(long roleId)
AccountRole	getAccountRole(long accountRoleId) Returns the account role with the primary key.
AccountRole	getAccountRoleByRoleId(long roleId)
java.util.List<AccountRole>	getAccountRoles(int start, int end) Returns a range of all the account roles.
java.util.List<AccountRole>	getAccountRoles(long accountEntryId, long userId)
java.util.List<AccountRole>	getAccountRolesByAccountEntryIds(long[] accountEntryIds)
int	getAccountRolesCount() Returns the number of account roles.
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
BaseModelSearchResult<AccountRole>	searchAccountRoles(long[] accountEntryIds, java.lang.String keywords, int start, int end, OrderByComparator<?> orderByComparator)
BaseModelSearchResult<AccountRole>	searchAccountRoles(long accountEntryId, java.lang.String keywords, int start, int end, OrderByComparator<?> orderByComparator)
void	unassociateUser(long accountEntryId, long accountRoleId, long userId)
AccountRole	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

getBasePersistence

Method Detail

addAccountRole

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

AccountRole addAccountRole(long userId,
                           long accountEntryId,
                           java.lang.String name,
                           java.util.Map<java.util.Locale,java.lang.String> titleMap,
                           java.util.Map<java.util.Locale,java.lang.String> descriptionMap)
                    throws PortalException

Throws:

PortalException

associateUser

void associateUser(long accountEntryId,
                   long accountRoleId,
                   long userId)
            throws PortalException

Throws:

PortalException

createAccountRole

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

PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                             throws PortalException

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteAccountRole

@Indexable(type=DELETE)
AccountRole deleteAccountRole(AccountRole accountRole)
                                               throws 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:

PortalException

deleteAccountRole

@Indexable(type=DELETE)
AccountRole deleteAccountRole(long accountRoleId)
                                               throws 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:

PortalException - if a account role with the primary key could not be found

deleteAccountRolesByCompanyId

void deleteAccountRolesByCompanyId(long companyId)

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

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

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

@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

fetchAccountRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AccountRole fetchAccountRole(long accountRoleId)

fetchAccountRoleByRoleId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AccountRole fetchAccountRoleByRoleId(long roleId)

getAccountRole

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AccountRole getAccountRole(long accountRoleId)
                                                                                       throws PortalException

Returns the account role with the primary key.

Parameters:

accountRoleId - the primary key of the account role

Returns:

the account role

Throws:

PortalException - if a account role with the primary key could not be found

getAccountRoleByRoleId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AccountRole getAccountRoleByRoleId(long roleId)
                                                                                               throws PortalException

Throws:

PortalException

getAccountRoles

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<AccountRole> getAccountRoles(long accountEntryId,
                                                                                                               long userId)
                                                                                                        throws PortalException

Throws:

PortalException

getAccountRolesByAccountEntryIds

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

getIndexableActionableDynamicQuery

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

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

searchAccountRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BaseModelSearchResult<AccountRole> searchAccountRoles(long accountEntryId,
                                                                                                                         java.lang.String keywords,
                                                                                                                         int start,
                                                                                                                         int end,
                                                                                                                         OrderByComparator<?> orderByComparator)

searchAccountRoles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BaseModelSearchResult<AccountRole> searchAccountRoles(long[] accountEntryIds,
                                                                                                                         java.lang.String keywords,
                                                                                                                         int start,
                                                                                                                         int end,
                                                                                                                         OrderByComparator<?> orderByComparator)

unassociateUser

void unassociateUser(long accountEntryId,
                     long accountRoleId,
                     long userId)
              throws PortalException

Throws:

PortalException

updateAccountRole

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