com.liferay.html.preview.service

Interface HtmlPreviewEntryLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

HtmlPreviewEntryLocalServiceWrapper

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

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

HtmlPreviewEntryLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
HtmlPreviewEntry	addHtmlPreviewEntry(HtmlPreviewEntry htmlPreviewEntry) Adds the html preview entry to the database.
HtmlPreviewEntry	addHtmlPreviewEntry(long userId, long groupId, long classNameId, long classPK, java.lang.String content, java.lang.String mimeType, ServiceContext serviceContext)
HtmlPreviewEntry	createHtmlPreviewEntry(long htmlPreviewEntryId) Creates a new html preview entry with the primary key.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
HtmlPreviewEntry	deleteHtmlPreviewEntry(HtmlPreviewEntry htmlPreviewEntry) Deletes the html preview entry from the database.
HtmlPreviewEntry	deleteHtmlPreviewEntry(long htmlPreviewEntryId) Deletes the html preview entry with the primary key from the database.
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.
HtmlPreviewEntry	fetchHtmlPreviewEntry(long htmlPreviewEntryId)
ActionableDynamicQuery	getActionableDynamicQuery()
java.util.List<HtmlPreviewEntry>	getHtmlPreviewEntries(int start, int end) Returns a range of all the html preview entries.
int	getHtmlPreviewEntriesCount() Returns the number of html preview entries.
HtmlPreviewEntry	getHtmlPreviewEntry(long htmlPreviewEntryId) Returns the html preview entry with the primary key.
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
HtmlPreviewEntry	updateHtmlPreviewEntry(HtmlPreviewEntry htmlPreviewEntry) Updates the html preview entry in the database or adds it if it does not yet exist.
HtmlPreviewEntry	updateHtmlPreviewEntry(long htmlPreviewEntryId, java.lang.String content, java.lang.String mimeType, ServiceContext serviceContext)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addHtmlPreviewEntry

@Indexable(type=REINDEX)
HtmlPreviewEntry addHtmlPreviewEntry(HtmlPreviewEntry htmlPreviewEntry)

Adds the html preview entry to the database. Also notifies the appropriate model listeners.

Important: Inspect HtmlPreviewEntryLocalServiceImpl 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:

htmlPreviewEntry - the html preview entry

Returns:

the html preview entry that was added

addHtmlPreviewEntry

HtmlPreviewEntry addHtmlPreviewEntry(long userId,
                                     long groupId,
                                     long classNameId,
                                     long classPK,
                                     java.lang.String content,
                                     java.lang.String mimeType,
                                     ServiceContext serviceContext)
                              throws PortalException

Throws:

PortalException

createHtmlPreviewEntry

@Transactional(enabled=false)
HtmlPreviewEntry createHtmlPreviewEntry(long htmlPreviewEntryId)

Creates a new html preview entry with the primary key. Does not add the html preview entry to the database.

Parameters:

htmlPreviewEntryId - the primary key for the new html preview entry

Returns:

the new html preview entry

createPersistedModel

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

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteHtmlPreviewEntry

@Indexable(type=DELETE)
HtmlPreviewEntry deleteHtmlPreviewEntry(HtmlPreviewEntry htmlPreviewEntry)
                                                         throws PortalException

Deletes the html preview entry from the database. Also notifies the appropriate model listeners.

Important: Inspect HtmlPreviewEntryLocalServiceImpl 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:

htmlPreviewEntry - the html preview entry

Returns:

the html preview entry that was removed

Throws:

PortalException

deleteHtmlPreviewEntry

@Indexable(type=DELETE)
HtmlPreviewEntry deleteHtmlPreviewEntry(long htmlPreviewEntryId)
                                                         throws PortalException

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

Important: Inspect HtmlPreviewEntryLocalServiceImpl 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:

htmlPreviewEntryId - the primary key of the html preview entry

Returns:

the html preview entry that was removed

Throws:

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

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.html.preview.model.impl.HtmlPreviewEntryModelImpl.

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.html.preview.model.impl.HtmlPreviewEntryModelImpl.

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

fetchHtmlPreviewEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
HtmlPreviewEntry fetchHtmlPreviewEntry(long htmlPreviewEntryId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getHtmlPreviewEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<HtmlPreviewEntry> getHtmlPreviewEntries(int start,
                                                                                                                          int end)

Returns a range of all the html preview 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.html.preview.model.impl.HtmlPreviewEntryModelImpl.

Parameters:

start - the lower bound of the range of html preview entries

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

Returns:

the range of html preview entries

getHtmlPreviewEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getHtmlPreviewEntriesCount()

Returns the number of html preview entries.

Returns:

the number of html preview entries

getHtmlPreviewEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
HtmlPreviewEntry getHtmlPreviewEntry(long htmlPreviewEntryId)
                                                                                                 throws PortalException

Returns the html preview entry with the primary key.

Parameters:

htmlPreviewEntryId - the primary key of the html preview entry

Returns:

the html preview entry

Throws:

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

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

updateHtmlPreviewEntry

@Indexable(type=REINDEX)
HtmlPreviewEntry updateHtmlPreviewEntry(HtmlPreviewEntry htmlPreviewEntry)

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

Important: Inspect HtmlPreviewEntryLocalServiceImpl 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:

htmlPreviewEntry - the html preview entry

Returns:

the html preview entry that was updated

updateHtmlPreviewEntry

HtmlPreviewEntry updateHtmlPreviewEntry(long htmlPreviewEntryId,
                                        java.lang.String content,
                                        java.lang.String mimeType,
                                        ServiceContext serviceContext)
                                 throws PortalException

Throws:

PortalException