Class EntryLocalServiceUtil
com.liferay.portal.reports.engine.console.service.impl.EntryLocalServiceImpl 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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic EntryaddEntry(long userId, long groupId, long definitionId, String format, boolean schedulerRequest, Date startDate, Date endDate, boolean repeating, String recurrence, String emailNotifications, String emailDelivery, String portletId, String pageURL, String reportName, String reportParameters, com.liferay.portal.kernel.service.ServiceContext serviceContext) static EntryAdds the entry to the database.static voidaddEntryResources(Entry entry, boolean addCommunityPermissions, boolean addGuestPermissions) static voidaddEntryResources(Entry entry, String[] communityPermissions, String[] guestPermissions) static EntrycreateEntry(long entryId) Creates a new entry with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static voiddeleteAttachment(long companyId, String fileName) static EntrydeleteEntry(long entryId) Deletes the entry with the primary key from the database.static EntrydeleteEntry(Entry entry) Deletes the entry from the database.static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.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.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.static longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(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.static EntryfetchEntry(long entryId) static voidgenerateReport(long entryId) static voidgenerateReport(long entryId, String reportName) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic String[]getAttachmentsFileNames(Entry entry) getEntries(int start, int end) Returns a range of all the entries.getEntries(long groupId, String definitionName, String userName, Date createDateGT, Date createDateLT, boolean andSearch, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Entry> orderByComparator) static intReturns the number of entries.static intgetEntriesCount(long groupId, String definitionName, String userName, Date createDateGT, Date createDateLT, boolean andSearch) static EntrygetEntry(long entryId) Returns the entry with the primary key.static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static EntryLocalServicestatic voidsendEmails(long entryId, String fileName, String[] emailAddresses, boolean notification) static voidunscheduleEntry(long entryId) static voidupdateEntry(long entryId, String reportName, byte[] reportResults) static EntryupdateEntry(Entry entry) Updates the entry in the database or adds it if it does not yet exist.static voidupdateEntryStatus(long entryId, ReportStatus status, String errorMessage)
-
Constructor Details
-
EntryLocalServiceUtil
public EntryLocalServiceUtil()
-
-
Method Details
-
addEntry
Adds the entry to the database. Also notifies the appropriate model listeners.Important: Inspect EntryLocalServiceImpl 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:
entry- the entry- Returns:
- the entry that was added
-
addEntry
public static Entry addEntry(long userId, long groupId, long definitionId, String format, boolean schedulerRequest, Date startDate, Date endDate, boolean repeating, String recurrence, String emailNotifications, String emailDelivery, String portletId, String pageURL, String reportName, String reportParameters, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addEntryResources
public static void addEntryResources(Entry entry, boolean addCommunityPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addEntryResources
public static void addEntryResources(Entry entry, String[] communityPermissions, String[] guestPermissions) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createEntry
Creates a new entry with the primary key. Does not add the entry to the database.- Parameters:
entryId- the primary key for the new entry- Returns:
- the new entry
-
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
-
deleteAttachment
public static void deleteAttachment(long companyId, String fileName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteEntry
public static Entry deleteEntry(Entry entry) throws com.liferay.portal.kernel.exception.PortalException Deletes the entry from the database. Also notifies the appropriate model listeners.Important: Inspect EntryLocalServiceImpl 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:
entry- the entry- Returns:
- the entry that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteEntry
public static Entry deleteEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException Deletes the entry with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect EntryLocalServiceImpl 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:
entryId- the primary key of the entry- Returns:
- the entry that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a entry with the primary key could not be found
-
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
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 - 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.portal.reports.engine.console.model.impl.EntryModelImpl.- 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(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 - 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.portal.reports.engine.console.model.impl.EntryModelImpl.- 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
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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchEntry
-
generateReport
public static void generateReport(long entryId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
generateReport
public static void generateReport(long entryId, String reportName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getAttachmentsFileNames
-
getEntries
Returns a range of all the entries.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.portal.reports.engine.console.model.impl.EntryModelImpl.- Parameters:
start- the lower bound of the range of entriesend- the upper bound of the range of entries (not inclusive)- Returns:
- the range of entries
-
getEntries
-
getEntriesCount
public static int getEntriesCount()Returns the number of entries.- Returns:
- the number of entries
-
getEntriesCount
-
getEntry
public static Entry getEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException Returns the entry with the primary key.- Parameters:
entryId- the primary key of the entry- Returns:
- the entry
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a entry with the primary key could not be found
-
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
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
-
sendEmails
public static void sendEmails(long entryId, String fileName, String[] emailAddresses, boolean notification) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
unscheduleEntry
public static void unscheduleEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateEntry
Updates the entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect EntryLocalServiceImpl 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:
entry- the entry- Returns:
- the entry that was updated
-
updateEntry
public static void updateEntry(long entryId, String reportName, byte[] reportResults) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateEntryStatus
public static void updateEntryStatus(long entryId, ReportStatus status, String errorMessage) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-