Interface MembershipRequestLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
MembershipRequestLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddMembershipRequest
(long userId, long groupId, String comments, ServiceContext serviceContext) addMembershipRequest
(MembershipRequest membershipRequest) Adds the membership request to the database.createMembershipRequest
(long membershipRequestId) Creates a new membership request with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteMembershipRequest
(long membershipRequestId) Deletes the membership request with the primary key from the database.deleteMembershipRequest
(MembershipRequest membershipRequest) Deletes the membership request from the database.void
deleteMembershipRequests
(long groupId) void
deleteMembershipRequests
(long groupId, long statusId) void
deleteMembershipRequestsByUserId
(long userId) deletePersistedModel
(PersistedModel persistedModel) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> 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> 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.fetchMembershipRequest
(long membershipRequestId) getMembershipRequest
(long membershipRequestId) Returns the membership request with the primary key.getMembershipRequests
(int start, int end) Returns a range of all the membership requests.getMembershipRequests
(long userId, long groupId, long statusId) int
Returns the number of membership requests.Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) boolean
hasMembershipRequest
(long userId, long groupId, long statusId) search
(long groupId, int status, int start, int end) search
(long groupId, int status, int start, int end, OrderByComparator<MembershipRequest> orderByComparator) int
searchCount
(long groupId, int status) updateMembershipRequest
(MembershipRequest membershipRequest) Updates the membership request in the database or adds it if it does not yet exist.void
updateStatus
(long replierUserId, long membershipRequestId, String replyComments, long statusId, boolean addUserToGroup, ServiceContext serviceContext) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addMembershipRequest
MembershipRequest addMembershipRequest(long userId, long groupId, String comments, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addMembershipRequest
@Indexable(type=REINDEX) MembershipRequest addMembershipRequest(MembershipRequest membershipRequest) Adds the membership request to the database. Also notifies the appropriate model listeners.Important: Inspect MembershipRequestLocalServiceImpl 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:
membershipRequest
- the membership request- Returns:
- the membership request that was added
-
createMembershipRequest
Creates a new membership request with the primary key. Does not add the membership request to the database.- Parameters:
membershipRequestId
- the primary key for the new membership request- Returns:
- the new membership request
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteMembershipRequest
@Indexable(type=DELETE) MembershipRequest deleteMembershipRequest(long membershipRequestId) throws PortalException Deletes the membership request with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect MembershipRequestLocalServiceImpl 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:
membershipRequestId
- the primary key of the membership request- Returns:
- the membership request that was removed
- Throws:
PortalException
- if a membership request with the primary key could not be found
-
deleteMembershipRequest
@Indexable(type=DELETE) MembershipRequest deleteMembershipRequest(MembershipRequest membershipRequest) Deletes the membership request from the database. Also notifies the appropriate model listeners.Important: Inspect MembershipRequestLocalServiceImpl 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:
membershipRequest
- the membership request- Returns:
- the membership request that was removed
-
deleteMembershipRequests
void deleteMembershipRequests(long groupId) -
deleteMembershipRequests
void deleteMembershipRequests(long groupId, long statusId) -
deleteMembershipRequestsByUserId
void deleteMembershipRequestsByUserId(long userId) -
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> 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> 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
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.portal.model.impl.MembershipRequestModelImpl
.- 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(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
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.portal.model.impl.MembershipRequestModelImpl
.- 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(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 queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchMembershipRequest
@Transactional(propagation=SUPPORTS, readOnly=true) MembershipRequest fetchMembershipRequest(long membershipRequestId) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getMembershipRequest
@Transactional(propagation=SUPPORTS, readOnly=true) MembershipRequest getMembershipRequest(long membershipRequestId) throws PortalException Returns the membership request with the primary key.- Parameters:
membershipRequestId
- the primary key of the membership request- Returns:
- the membership request
- Throws:
PortalException
- if a membership request with the primary key could not be found
-
getMembershipRequests
@Transactional(propagation=SUPPORTS, readOnly=true) List<MembershipRequest> getMembershipRequests(int start, int end) Returns a range of all the membership requests.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.portal.model.impl.MembershipRequestModelImpl
.- Parameters:
start
- the lower bound of the range of membership requestsend
- the upper bound of the range of membership requests (not inclusive)- Returns:
- the range of membership requests
-
getMembershipRequests
@Transactional(propagation=SUPPORTS, readOnly=true) List<MembershipRequest> getMembershipRequests(long userId, long groupId, long statusId) -
getMembershipRequestsCount
Returns the number of membership requests.- Returns:
- the number of membership requests
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
hasMembershipRequest
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasMembershipRequest(long userId, long groupId, long statusId) -
search
@Transactional(propagation=SUPPORTS, readOnly=true) List<MembershipRequest> search(long groupId, int status, int start, int end) -
search
@Transactional(propagation=SUPPORTS, readOnly=true) List<MembershipRequest> search(long groupId, int status, int start, int end, OrderByComparator<MembershipRequest> orderByComparator) -
searchCount
-
updateMembershipRequest
@Indexable(type=REINDEX) MembershipRequest updateMembershipRequest(MembershipRequest membershipRequest) Updates the membership request in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect MembershipRequestLocalServiceImpl 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:
membershipRequest
- the membership request- Returns:
- the membership request that was updated
-
updateStatus
void updateStatus(long replierUserId, long membershipRequestId, String replyComments, long statusId, boolean addUserToGroup, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-