com.liferay.fragment.service

Class FragmentEntryLocalServiceUtil

java.lang.Object

com.liferay.fragment.service.FragmentEntryLocalServiceUtil

public class FragmentEntryLocalServiceUtil
extends java.lang.Object

Provides the local service utility for FragmentEntry. This utility wraps com.liferay.fragment.service.impl.FragmentEntryLocalServiceImpl 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:

FragmentEntryLocalService

Constructor Summary

Constructors

Constructor and Description
FragmentEntryLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static FragmentEntry	addFragmentEntry(FragmentEntry fragmentEntry) Adds the fragment entry to the database.
static FragmentEntry	addFragmentEntry(long userId, long groupId, long fragmentCollectionId, java.lang.String fragmentEntryKey, java.lang.String name, long previewFileEntryId, int type, int status, ServiceContext serviceContext)
static FragmentEntry	addFragmentEntry(long userId, long groupId, long fragmentCollectionId, java.lang.String fragmentEntryKey, java.lang.String name, java.lang.String css, java.lang.String html, java.lang.String js, boolean cacheable, java.lang.String configuration, long previewFileEntryId, int type, int status, ServiceContext serviceContext)
static FragmentEntry	addFragmentEntry(long userId, long groupId, long fragmentCollectionId, java.lang.String fragmentEntryKey, java.lang.String name, java.lang.String css, java.lang.String html, java.lang.String js, java.lang.String configuration, long previewFileEntryId, int type, int status, ServiceContext serviceContext)
static FragmentEntry	checkout(FragmentEntry publishedFragmentEntry, int version)
static FragmentEntry	copyFragmentEntry(long userId, long groupId, long fragmentEntryId, long fragmentCollectionId, ServiceContext serviceContext)
static FragmentEntry	create() Creates a new fragment entry.
static FragmentEntry	createFragmentEntry(long fragmentEntryId)
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static FragmentEntry	delete(FragmentEntry publishedFragmentEntry)
static FragmentEntry	deleteDraft(FragmentEntry draftFragmentEntry)
static FragmentEntry	deleteFragmentEntry(FragmentEntry fragmentEntry) Deletes the fragment entry from the database.
static FragmentEntry	deleteFragmentEntry(long fragmentEntryId) Deletes the fragment entry with the primary key from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static FragmentEntryVersion	deleteVersion(FragmentEntryVersion fragmentEntryVersion)
static <T> T	dslQuery(DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <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.
static <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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static FragmentEntry	fetchDraft(FragmentEntry fragmentEntry)
static FragmentEntry	fetchDraft(long primaryKey)
static FragmentEntry	fetchFragmentEntry(long fragmentEntryId)
static FragmentEntry	fetchFragmentEntry(long groupId, java.lang.String fragmentEntryKey)
static FragmentEntry	fetchFragmentEntryByUuidAndGroupId(java.lang.String uuid, long groupId)
static FragmentEntryVersion	fetchLatestVersion(FragmentEntry fragmentEntry)
static FragmentEntry	fetchPublished(FragmentEntry fragmentEntry)
static FragmentEntry	fetchPublished(long primaryKey)
static java.lang.String	generateFragmentEntryKey(long groupId, java.lang.String name)
static ActionableDynamicQuery	getActionableDynamicQuery()
static FragmentEntry	getDraft(FragmentEntry fragmentEntry)
static FragmentEntry	getDraft(long primaryKey)
static ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
static java.util.List<FragmentEntry>	getFragmentEntries(int start, int end) Returns a range of all the fragment entries.
static java.util.List<FragmentEntry>	getFragmentEntries(long fragmentCollectionId)
static java.util.List<FragmentEntry>	getFragmentEntries(long fragmentCollectionId, int start, int end)
static java.util.List<FragmentEntry>	getFragmentEntries(long groupId, long fragmentCollectionId, int status)
static java.util.List<FragmentEntry>	getFragmentEntries(long groupId, long fragmentCollectionId, int start, int end, OrderByComparator<FragmentEntry> orderByComparator)
static java.util.List<FragmentEntry>	getFragmentEntries(long groupId, long fragmentCollectionId, java.lang.String name, int start, int end, OrderByComparator<FragmentEntry> orderByComparator)
static java.util.List<FragmentEntry>	getFragmentEntriesByUuidAndCompanyId(java.lang.String uuid, long companyId)
static java.util.List<FragmentEntry>	getFragmentEntriesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, OrderByComparator<FragmentEntry> orderByComparator)
static int	getFragmentEntriesCount() Returns the number of fragment entries.
static int	getFragmentEntriesCount(long fragmentCollectionId)
static FragmentEntry	getFragmentEntry(long fragmentEntryId) Returns the fragment entry with the primary key.
static FragmentEntry	getFragmentEntryByUuidAndGroupId(java.lang.String uuid, long groupId)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static FragmentEntryLocalService	getService()
static java.lang.String[]	getTempFileNames(long userId, long groupId, java.lang.String folderName)
static FragmentEntryVersion	getVersion(FragmentEntry fragmentEntry, int version)
static java.util.List<FragmentEntryVersion>	getVersions(FragmentEntry fragmentEntry)
static FragmentEntry	moveFragmentEntry(long fragmentEntryId, long fragmentCollectionId)
static FragmentEntry	publishDraft(FragmentEntry draftFragmentEntry)
static void	registerListener(VersionServiceListener<FragmentEntry,FragmentEntryVersion> versionServiceListener)
static void	unregisterListener(VersionServiceListener<FragmentEntry,FragmentEntryVersion> versionServiceListener)
static FragmentEntry	updateDraft(FragmentEntry draftFragmentEntry)
static FragmentEntry	updateFragmentEntry(FragmentEntry draftFragmentEntry) Updates the fragment entry in the database or adds it if it does not yet exist.
static FragmentEntry	updateFragmentEntry(long fragmentEntryId, long previewFileEntryId)
static FragmentEntry	updateFragmentEntry(long userId, long fragmentEntryId, java.lang.String name, java.lang.String css, java.lang.String html, java.lang.String js, boolean cacheable, java.lang.String configuration, long previewFileEntryId, int status)
static FragmentEntry	updateFragmentEntry(long userId, long fragmentEntryId, java.lang.String name, java.lang.String css, java.lang.String html, java.lang.String js, java.lang.String configuration, int status)
static FragmentEntry	updateFragmentEntry(long userId, long fragmentEntryId, java.lang.String name, java.lang.String css, java.lang.String html, java.lang.String js, java.lang.String configuration, long previewFileEntryId, int status)
static FragmentEntry	updateFragmentEntry(long fragmentEntryId, java.lang.String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FragmentEntryLocalServiceUtil

public FragmentEntryLocalServiceUtil()

Method Detail

addFragmentEntry

public static FragmentEntry addFragmentEntry(FragmentEntry fragmentEntry)

Adds the fragment entry to the database. Also notifies the appropriate model listeners.

Parameters:

fragmentEntry - the fragment entry

Returns:

the fragment entry that was added

addFragmentEntry

public static FragmentEntry addFragmentEntry(long userId,
                                             long groupId,
                                             long fragmentCollectionId,
                                             java.lang.String fragmentEntryKey,
                                             java.lang.String name,
                                             long previewFileEntryId,
                                             int type,
                                             int status,
                                             ServiceContext serviceContext)
                                      throws PortalException

Throws:

PortalException

addFragmentEntry

public static FragmentEntry addFragmentEntry(long userId,
                                             long groupId,
                                             long fragmentCollectionId,
                                             java.lang.String fragmentEntryKey,
                                             java.lang.String name,
                                             java.lang.String css,
                                             java.lang.String html,
                                             java.lang.String js,
                                             boolean cacheable,
                                             java.lang.String configuration,
                                             long previewFileEntryId,
                                             int type,
                                             int status,
                                             ServiceContext serviceContext)
                                      throws PortalException

Throws:

PortalException

addFragmentEntry

public static FragmentEntry addFragmentEntry(long userId,
                                             long groupId,
                                             long fragmentCollectionId,
                                             java.lang.String fragmentEntryKey,
                                             java.lang.String name,
                                             java.lang.String css,
                                             java.lang.String html,
                                             java.lang.String js,
                                             java.lang.String configuration,
                                             long previewFileEntryId,
                                             int type,
                                             int status,
                                             ServiceContext serviceContext)
                                      throws PortalException

Throws:

PortalException

checkout

public static FragmentEntry checkout(FragmentEntry publishedFragmentEntry,
                                     int version)
                              throws PortalException

Throws:

PortalException

copyFragmentEntry

public static FragmentEntry copyFragmentEntry(long userId,
                                              long groupId,
                                              long fragmentEntryId,
                                              long fragmentCollectionId,
                                              ServiceContext serviceContext)
                                       throws PortalException

Throws:

PortalException

create

public static FragmentEntry create()

Creates a new fragment entry. Does not add the fragment entry to the database.

Returns:

the new fragment entry

createFragmentEntry

public static FragmentEntry createFragmentEntry(long fragmentEntryId)

createPersistedModel

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

Throws:

PortalException

delete

public static FragmentEntry delete(FragmentEntry publishedFragmentEntry)
                            throws PortalException

Throws:

PortalException

deleteDraft

public static FragmentEntry deleteDraft(FragmentEntry draftFragmentEntry)
                                 throws PortalException

Throws:

PortalException

deleteFragmentEntry

public static FragmentEntry deleteFragmentEntry(FragmentEntry fragmentEntry)
                                         throws PortalException

Deletes the fragment entry from the database. Also notifies the appropriate model listeners.

Parameters:

fragmentEntry - the fragment entry

Returns:

the fragment entry that was removed

Throws:

PortalException

deleteFragmentEntry

public static FragmentEntry deleteFragmentEntry(long fragmentEntryId)
                                         throws PortalException

Deletes the fragment entry with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

fragmentEntryId - the primary key of the fragment entry

Returns:

the fragment entry that was removed

Throws:

PortalException - if a fragment entry with the primary key could not be found

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteVersion

public static FragmentEntryVersion deleteVersion(FragmentEntryVersion fragmentEntryVersion)
                                          throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public static <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.fragment.model.impl.FragmentEntryModelImpl.

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

public static <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.fragment.model.impl.FragmentEntryModelImpl.

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

public static 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

public static 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

fetchDraft

public static FragmentEntry fetchDraft(FragmentEntry fragmentEntry)

fetchDraft

public static FragmentEntry fetchDraft(long primaryKey)

fetchFragmentEntry

public static FragmentEntry fetchFragmentEntry(long fragmentEntryId)

fetchFragmentEntry

public static FragmentEntry fetchFragmentEntry(long groupId,
                                               java.lang.String fragmentEntryKey)

fetchFragmentEntryByUuidAndGroupId

public static FragmentEntry fetchFragmentEntryByUuidAndGroupId(java.lang.String uuid,
                                                               long groupId)

fetchLatestVersion

public static FragmentEntryVersion fetchLatestVersion(FragmentEntry fragmentEntry)

fetchPublished

public static FragmentEntry fetchPublished(FragmentEntry fragmentEntry)

fetchPublished

public static FragmentEntry fetchPublished(long primaryKey)

generateFragmentEntryKey

public static java.lang.String generateFragmentEntryKey(long groupId,
                                                        java.lang.String name)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getDraft

public static FragmentEntry getDraft(FragmentEntry fragmentEntry)
                              throws PortalException

Throws:

PortalException

getDraft

public static FragmentEntry getDraft(long primaryKey)
                              throws PortalException

Throws:

PortalException

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getFragmentEntries

public static java.util.List<FragmentEntry> getFragmentEntries(int start,
                                                               int end)

Returns a range of all the fragment entries.

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.fragment.model.impl.FragmentEntryModelImpl.

Parameters:

start - the lower bound of the range of fragment entries

end - the upper bound of the range of fragment entries (not inclusive)

Returns:

the range of fragment entries

getFragmentEntries

public static java.util.List<FragmentEntry> getFragmentEntries(long fragmentCollectionId)

getFragmentEntries

public static java.util.List<FragmentEntry> getFragmentEntries(long fragmentCollectionId,
                                                               int start,
                                                               int end)

getFragmentEntries

public static java.util.List<FragmentEntry> getFragmentEntries(long groupId,
                                                               long fragmentCollectionId,
                                                               int status)

getFragmentEntries

public static java.util.List<FragmentEntry> getFragmentEntries(long groupId,
                                                               long fragmentCollectionId,
                                                               int start,
                                                               int end,
                                                               OrderByComparator<FragmentEntry> orderByComparator)

getFragmentEntries

public static java.util.List<FragmentEntry> getFragmentEntries(long groupId,
                                                               long fragmentCollectionId,
                                                               java.lang.String name,
                                                               int start,
                                                               int end,
                                                               OrderByComparator<FragmentEntry> orderByComparator)

getFragmentEntriesByUuidAndCompanyId

public static java.util.List<FragmentEntry> getFragmentEntriesByUuidAndCompanyId(java.lang.String uuid,
                                                                                 long companyId)

getFragmentEntriesByUuidAndCompanyId

public static java.util.List<FragmentEntry> getFragmentEntriesByUuidAndCompanyId(java.lang.String uuid,
                                                                                 long companyId,
                                                                                 int start,
                                                                                 int end,
                                                                                 OrderByComparator<FragmentEntry> orderByComparator)

getFragmentEntriesCount

public static int getFragmentEntriesCount()

Returns the number of fragment entries.

Returns:

the number of fragment entries

getFragmentEntriesCount

public static int getFragmentEntriesCount(long fragmentCollectionId)

getFragmentEntry

public static FragmentEntry getFragmentEntry(long fragmentEntryId)
                                      throws PortalException

Returns the fragment entry with the primary key.

Parameters:

fragmentEntryId - the primary key of the fragment entry

Returns:

the fragment entry

Throws:

PortalException - if a fragment entry with the primary key could not be found

getFragmentEntryByUuidAndGroupId

public static FragmentEntry getFragmentEntryByUuidAndGroupId(java.lang.String uuid,
                                                             long groupId)
                                                      throws PortalException

Throws:

PortalException

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getTempFileNames

public static java.lang.String[] getTempFileNames(long userId,
                                                  long groupId,
                                                  java.lang.String folderName)
                                           throws PortalException

Throws:

PortalException

getVersion

public static FragmentEntryVersion getVersion(FragmentEntry fragmentEntry,
                                              int version)
                                       throws PortalException

Throws:

PortalException

getVersions

public static java.util.List<FragmentEntryVersion> getVersions(FragmentEntry fragmentEntry)

moveFragmentEntry

public static FragmentEntry moveFragmentEntry(long fragmentEntryId,
                                              long fragmentCollectionId)
                                       throws PortalException

Throws:

PortalException

publishDraft

public static FragmentEntry publishDraft(FragmentEntry draftFragmentEntry)
                                  throws PortalException

Throws:

PortalException

registerListener

public static void registerListener(VersionServiceListener<FragmentEntry,FragmentEntryVersion> versionServiceListener)

unregisterListener

public static void unregisterListener(VersionServiceListener<FragmentEntry,FragmentEntryVersion> versionServiceListener)

updateDraft

public static FragmentEntry updateDraft(FragmentEntry draftFragmentEntry)
                                 throws PortalException

Throws:

PortalException

updateFragmentEntry

public static FragmentEntry updateFragmentEntry(FragmentEntry draftFragmentEntry)
                                         throws PortalException

Updates the fragment entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

fragmentEntry - the fragment entry

Returns:

the fragment entry that was updated

Throws:

PortalException

updateFragmentEntry

public static FragmentEntry updateFragmentEntry(long fragmentEntryId,
                                                long previewFileEntryId)
                                         throws PortalException

Throws:

PortalException

updateFragmentEntry

public static FragmentEntry updateFragmentEntry(long userId,
                                                long fragmentEntryId,
                                                java.lang.String name,
                                                java.lang.String css,
                                                java.lang.String html,
                                                java.lang.String js,
                                                boolean cacheable,
                                                java.lang.String configuration,
                                                long previewFileEntryId,
                                                int status)
                                         throws PortalException

Throws:

PortalException

updateFragmentEntry

public static FragmentEntry updateFragmentEntry(long userId,
                                                long fragmentEntryId,
                                                java.lang.String name,
                                                java.lang.String css,
                                                java.lang.String html,
                                                java.lang.String js,
                                                java.lang.String configuration,
                                                int status)
                                         throws PortalException

Throws:

PortalException

updateFragmentEntry

public static FragmentEntry updateFragmentEntry(long userId,
                                                long fragmentEntryId,
                                                java.lang.String name,
                                                java.lang.String css,
                                                java.lang.String html,
                                                java.lang.String js,
                                                java.lang.String configuration,
                                                long previewFileEntryId,
                                                int status)
                                         throws PortalException

Throws:

PortalException

updateFragmentEntry

public static FragmentEntry updateFragmentEntry(long fragmentEntryId,
                                                java.lang.String name)
                                         throws PortalException

Throws:

PortalException

getService

public static FragmentEntryLocalService getService()