Class AnnouncementsFlagLocalServiceUtil
com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl 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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic AnnouncementsFlagaddAnnouncementsFlag(AnnouncementsFlag announcementsFlag) Adds the announcements flag to the database.static AnnouncementsFlagaddFlag(long userId, long entryId, int value) static AnnouncementsFlagcreateAnnouncementsFlag(long flagId) Creates a new announcements flag with the primary key.static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static AnnouncementsFlagdeleteAnnouncementsFlag(long flagId) Deletes the announcements flag with the primary key from the database.static AnnouncementsFlagdeleteAnnouncementsFlag(AnnouncementsFlag announcementsFlag) Deletes the announcements flag from the database.static voiddeleteFlag(long flagId) static voiddeleteFlag(AnnouncementsFlag flag) static voiddeleteFlags(long entryId) static PersistedModeldeletePersistedModel(PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuerystatic <T> List<T>dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static AnnouncementsFlagfetchAnnouncementsFlag(long flagId) static ActionableDynamicQuerystatic AnnouncementsFlaggetAnnouncementsFlag(long flagId) Returns the announcements flag with the primary key.static List<AnnouncementsFlag>getAnnouncementsFlags(int start, int end) Returns a range of all the announcements flags.static intReturns the number of announcements flags.static AnnouncementsFlaggetFlag(long userId, long entryId, int value) static StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static voidsetService(AnnouncementsFlagLocalService service) static AnnouncementsFlagupdateAnnouncementsFlag(AnnouncementsFlag announcementsFlag) Updates the announcements flag in the database or adds it if it does not yet exist.
-
Constructor Details
-
AnnouncementsFlagLocalServiceUtil
public AnnouncementsFlagLocalServiceUtil()
-
-
Method Details
-
addAnnouncementsFlag
Adds the announcements flag to the database. Also notifies the appropriate model listeners.Important: Inspect AnnouncementsFlagLocalServiceImpl 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:
announcementsFlag- the announcements flag- Returns:
- the announcements flag that was added
-
addFlag
-
createAnnouncementsFlag
Creates a new announcements flag with the primary key. Does not add the announcements flag to the database.- Parameters:
flagId- the primary key for the new announcements flag- Returns:
- the new announcements flag
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteAnnouncementsFlag
Deletes the announcements flag from the database. Also notifies the appropriate model listeners.Important: Inspect AnnouncementsFlagLocalServiceImpl 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:
announcementsFlag- the announcements flag- Returns:
- the announcements flag that was removed
-
deleteAnnouncementsFlag
Deletes the announcements flag with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect AnnouncementsFlagLocalServiceImpl 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:
flagId- the primary key of the announcements flag- Returns:
- the announcements flag that was removed
- Throws:
PortalException- if a announcements flag with the primary key could not be found
-
deleteFlag
-
deleteFlag
- Throws:
PortalException
-
deleteFlags
public static void deleteFlags(long entryId) -
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
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
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.announcements.model.impl.AnnouncementsFlagModelImpl.- 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
public static <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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.announcements.model.impl.AnnouncementsFlagModelImpl.- 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
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
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
-
fetchAnnouncementsFlag
-
getActionableDynamicQuery
-
getAnnouncementsFlag
Returns the announcements flag with the primary key.- Parameters:
flagId- the primary key of the announcements flag- Returns:
- the announcements flag
- Throws:
PortalException- if a announcements flag with the primary key could not be found
-
getAnnouncementsFlags
Returns a range of all the announcements flags.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.announcements.model.impl.AnnouncementsFlagModelImpl.- Parameters:
start- the lower bound of the range of announcements flagsend- the upper bound of the range of announcements flags (not inclusive)- Returns:
- the range of announcements flags
-
getAnnouncementsFlagsCount
public static int getAnnouncementsFlagsCount()Returns the number of announcements flags.- Returns:
- the number of announcements flags
-
getFlag
public static AnnouncementsFlag getFlag(long userId, long entryId, int value) throws PortalException - Throws:
PortalException
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
updateAnnouncementsFlag
Updates the announcements flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect AnnouncementsFlagLocalServiceImpl 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:
announcementsFlag- the announcements flag- Returns:
- the announcements flag that was updated
-
getService
-
setService
-