com.liferay.style.book.service

Interface StyleBookEntryLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService, VersionService<StyleBookEntry,StyleBookEntryVersion>

All Known Implementing Classes:

StyleBookEntryLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface StyleBookEntryLocalService
extends BaseLocalService, PersistedModelLocalService, VersionService<StyleBookEntry,StyleBookEntryVersion>

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

StyleBookEntryLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
StyleBookEntry	addStyleBookEntry(long userId, long groupId, java.lang.String name, java.lang.String styleBookEntryKey, ServiceContext serviceContext)
StyleBookEntry	addStyleBookEntry(long userId, long groupId, java.lang.String frontendTokensValues, java.lang.String name, java.lang.String styleBookEntryKey, ServiceContext serviceContext)
StyleBookEntry	addStyleBookEntry(StyleBookEntry styleBookEntry) Adds the style book entry to the database.
StyleBookEntry	checkout(StyleBookEntry publishedStyleBookEntry, int version) Checks out the previous version of the versioned model and saves it as a draft.
StyleBookEntry	copyStyleBookEntry(long userId, long groupId, long styleBookEntryId, ServiceContext serviceContext)
StyleBookEntry	create() Creates a new style book entry.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
StyleBookEntry	delete(StyleBookEntry publishedStyleBookEntry) Deletes the VersionedModel.
StyleBookEntry	deleteDraft(StyleBookEntry draftStyleBookEntry) Deletes the VersionedModel if it is a draft.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
StyleBookEntry	deleteStyleBookEntry(long styleBookEntryId) Deletes the style book entry with the primary key from the database.
StyleBookEntry	deleteStyleBookEntry(StyleBookEntry styleBookEntry) Deletes the style book entry from the database.
StyleBookEntryVersion	deleteVersion(StyleBookEntryVersion styleBookEntryVersion) Deletes the VersionModel if it is not the latest version.
<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.
StyleBookEntry	fetchDefaultStyleBookEntry(long groupId)
StyleBookEntry	fetchDraft(long primaryKey) Fetches the draft if it exists; otherwise, returns null.
StyleBookEntry	fetchDraft(StyleBookEntry styleBookEntry) Fetches the draft if it exists; otherwise, returns null.
StyleBookEntryVersion	fetchLatestVersion(StyleBookEntry styleBookEntry) Fetches the latest version model if it exists.
StyleBookEntry	fetchPublished(long primaryKey) Fetches the published versioned model if it exists; otherwise, returns null.
StyleBookEntry	fetchPublished(StyleBookEntry styleBookEntry) Fetches the published versioned model if it exists.
StyleBookEntry	fetchStyleBookEntry(long styleBookEntryId)
StyleBookEntry	fetchStyleBookEntry(long groupId, java.lang.String styleBookEntryKey)
java.lang.String	generateStyleBookEntryKey(long groupId, java.lang.String name)
ActionableDynamicQuery	getActionableDynamicQuery()
StyleBookEntry	getDraft(long primaryKey) Returns the versioned model draft with the primary key.
StyleBookEntry	getDraft(StyleBookEntry styleBookEntry) Returns the versioned model draft.
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.List<StyleBookEntry>	getStyleBookEntries(int start, int end) Returns a range of all the style book entries.
java.util.List<StyleBookEntry>	getStyleBookEntries(long groupId, int start, int end, OrderByComparator<StyleBookEntry> orderByComparator)
java.util.List<StyleBookEntry>	getStyleBookEntries(long groupId, java.lang.String name, int start, int end, OrderByComparator<StyleBookEntry> orderByComparator)
int	getStyleBookEntriesCount() Returns the number of style book entries.
int	getStyleBookEntriesCount(long groupId)
int	getStyleBookEntriesCount(long groupId, java.lang.String name)
StyleBookEntry	getStyleBookEntry(long styleBookEntryId) Returns the style book entry with the primary key.
StyleBookEntryVersion	getVersion(StyleBookEntry styleBookEntry, int version) Returns the VersionModel for the VersionedModel matching the version.
java.util.List<StyleBookEntryVersion>	getVersions(StyleBookEntry styleBookEntry) Returns the VersionModels for the VersionedModel.
StyleBookEntry	publishDraft(StyleBookEntry draftStyleBookEntry) Publishes the draft and creates a new version model for the new version.
void	registerListener(VersionServiceListener<StyleBookEntry,StyleBookEntryVersion> versionServiceListener) Registers the VersionServiceListener.
void	unregisterListener(VersionServiceListener<StyleBookEntry,StyleBookEntryVersion> versionServiceListener) Unregisters the VersionServiceListener.
StyleBookEntry	updateDefaultStyleBookEntry(long styleBookEntryId, boolean defaultStyleBookEntry)
StyleBookEntry	updateDraft(StyleBookEntry draftStyleBookEntry) Updates the draft.
StyleBookEntry	updateFrontendTokensValues(long styleBookEntryId, java.lang.String frontendTokensValues)
StyleBookEntry	updateName(long styleBookEntryId, java.lang.String name)
StyleBookEntry	updatePreviewFileEntryId(long styleBookEntryId, long previewFileEntryId)
StyleBookEntry	updateStyleBookEntry(long styleBookEntryId, java.lang.String frontendTokensValues, java.lang.String name)
StyleBookEntry	updateStyleBookEntry(StyleBookEntry draftStyleBookEntry) Updates the style book entry in the database or adds it if it does not yet exist.

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

getBasePersistence

Method Detail

addStyleBookEntry

StyleBookEntry addStyleBookEntry(long userId,
                                 long groupId,
                                 java.lang.String name,
                                 java.lang.String styleBookEntryKey,
                                 ServiceContext serviceContext)
                          throws PortalException

Throws:

PortalException

addStyleBookEntry

StyleBookEntry addStyleBookEntry(long userId,
                                 long groupId,
                                 java.lang.String frontendTokensValues,
                                 java.lang.String name,
                                 java.lang.String styleBookEntryKey,
                                 ServiceContext serviceContext)
                          throws PortalException

Throws:

PortalException

addStyleBookEntry

@Indexable(type=REINDEX)
StyleBookEntry addStyleBookEntry(StyleBookEntry styleBookEntry)

Adds the style book entry to the database. Also notifies the appropriate model listeners.

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

styleBookEntry - the style book entry

Returns:

the style book entry that was added

checkout

@Indexable(type=REINDEX)
StyleBookEntry checkout(StyleBookEntry publishedStyleBookEntry,
                                                 int version)
                                          throws PortalException

Description copied from interface: VersionService

Checks out the previous version of the versioned model and saves it as a draft. Any VersionServiceListener that has been registered is also notified. An IllegalArgumentException is thrown if the versioned model already has a draft.

Specified by:

checkout in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

publishedStyleBookEntry - the published versioned model

version - the version

Returns:

the draft VersionModel being checked out

Throws:

PortalException - if the version does not exist

copyStyleBookEntry

StyleBookEntry copyStyleBookEntry(long userId,
                                  long groupId,
                                  long styleBookEntryId,
                                  ServiceContext serviceContext)
                           throws PortalException

Throws:

PortalException

create

@Transactional(enabled=false)
StyleBookEntry create()

Creates a new style book entry. Does not add the style book entry to the database.

Specified by:

create in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Returns:

the new style book entry

createPersistedModel

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

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

delete

@Indexable(type=DELETE)
StyleBookEntry delete(StyleBookEntry publishedStyleBookEntry)
                                       throws PortalException

Description copied from interface: VersionService

Deletes the VersionedModel. Related drafts and versions are also deleted. Any VersionServiceListener that has been registered is notified. An IllegalArgumentException is thrown if the versioned model is a draft. Drafts can be deleted by calling VersionService.deleteDraft(VersionedModel).

Specified by:

delete in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

publishedStyleBookEntry - the published versioned model

Returns:

the versioned model that is deleted

Throws:

PortalException - if a portal exception occurred

deleteDraft

@Indexable(type=DELETE)
StyleBookEntry deleteDraft(StyleBookEntry draftStyleBookEntry)
                                            throws PortalException

Description copied from interface: VersionService

Deletes the VersionedModel if it is a draft. Any VersionServiceListener that has been registered is notified. An IllegalArgumentException is thrown if the versioned model is not a draft. Published versioned models can be deleted by calling VersionService.delete(VersionedModel).

Specified by:

deleteDraft in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

draftStyleBookEntry - the draft versioned model

Returns:

the versioned model that is deleted

Throws:

PortalException - if a portal exception occurred

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteStyleBookEntry

@Indexable(type=DELETE)
StyleBookEntry deleteStyleBookEntry(long styleBookEntryId)
                                                     throws PortalException

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

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

styleBookEntryId - the primary key of the style book entry

Returns:

the style book entry that was removed

Throws:

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

deleteStyleBookEntry

@Indexable(type=DELETE)
StyleBookEntry deleteStyleBookEntry(StyleBookEntry styleBookEntry)
                                                     throws PortalException

Deletes the style book entry from the database. Also notifies the appropriate model listeners.

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

styleBookEntry - the style book entry

Returns:

the style book entry that was removed

Throws:

PortalException

deleteVersion

StyleBookEntryVersion deleteVersion(StyleBookEntryVersion styleBookEntryVersion)
                             throws PortalException

Description copied from interface: VersionService

Deletes the VersionModel if it is not the latest version. Any VersionServiceListener that has been registered is notified. An IllegalArgumentException is thrown if the versioned model is the latest version.

Specified by:

deleteVersion in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

styleBookEntryVersion - the version model

Returns:

the version model that is deleted

Throws:

PortalException - if a portal exception occurred

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.style.book.model.impl.StyleBookEntryModelImpl.

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.style.book.model.impl.StyleBookEntryModelImpl.

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

fetchDefaultStyleBookEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
StyleBookEntry fetchDefaultStyleBookEntry(long groupId)

fetchDraft

@Transactional(propagation=SUPPORTS,
               readOnly=true)
StyleBookEntry fetchDraft(long primaryKey)

Description copied from interface: VersionService

Fetches the draft if it exists; otherwise, returns null.

Specified by:

fetchDraft in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

primaryKey - the draft or published versioned model's primary key

Returns:

the draft versioned model if it exists; otherwise null

fetchDraft

@Transactional(propagation=SUPPORTS,
               readOnly=true)
StyleBookEntry fetchDraft(StyleBookEntry styleBookEntry)

Description copied from interface: VersionService

Fetches the draft if it exists; otherwise, returns null.

Specified by:

fetchDraft in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

styleBookEntry - the draft or published versioned model

Returns:

the draft versioned model if it exists; otherwise null

fetchLatestVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
StyleBookEntryVersion fetchLatestVersion(StyleBookEntry styleBookEntry)

Description copied from interface: VersionService

Fetches the latest version model if it exists. If the versioned model has never been published, null is returned.

Specified by:

fetchLatestVersion in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

styleBookEntry - the versioned model

Returns:

the latest version model if it exists; otherwise null

fetchPublished

@Transactional(propagation=SUPPORTS,
               readOnly=true)
StyleBookEntry fetchPublished(long primaryKey)

Description copied from interface: VersionService

Fetches the published versioned model if it exists; otherwise, returns null.

Specified by:

fetchPublished in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

primaryKey - the published versioned model's primary key

Returns:

the published versioned model if it exists; otherwise null

fetchPublished

@Transactional(propagation=SUPPORTS,
               readOnly=true)
StyleBookEntry fetchPublished(StyleBookEntry styleBookEntry)

Description copied from interface: VersionService

Fetches the published versioned model if it exists. If the versioned model has never been published, null is returned.

Specified by:

fetchPublished in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

styleBookEntry - the versioned model

Returns:

the published versioned model if it exists; otherwise null

fetchStyleBookEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
StyleBookEntry fetchStyleBookEntry(long styleBookEntryId)

fetchStyleBookEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
StyleBookEntry fetchStyleBookEntry(long groupId,
                                                                                                      java.lang.String styleBookEntryKey)

generateStyleBookEntryKey

java.lang.String generateStyleBookEntryKey(long groupId,
                                           java.lang.String name)

getActionableDynamicQuery

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

getDraft

@Transactional(propagation=SUPPORTS,
               readOnly=true)
StyleBookEntry getDraft(long primaryKey)
                                                                                    throws PortalException

Description copied from interface: VersionService

Returns the versioned model draft with the primary key. If it does not exist, a new draft is lazily created and added to the database. If a draft is lazily created, any VersionServiceListener that has been registered is notified.

Specified by:

getDraft in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

primaryKey - of the draft or published versioned model

Returns:

the versioned model

Throws:

PortalException - if no draft or published versioned model exists with the primary key

getDraft

@Transactional(propagation=SUPPORTS,
               readOnly=true)
StyleBookEntry getDraft(StyleBookEntry styleBookEntry)
                                                                                    throws PortalException

Description copied from interface: VersionService

Returns the versioned model draft. If the draft does not exist, it is lazily created, adding it to the database. If a draft is lazily created, any VersionServiceListener that has been registered is notified.

Specified by:

getDraft in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

styleBookEntry - the versioned model

Returns:

the versioned model

Throws:

PortalException - if a portal exception occurred

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

getStyleBookEntries

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

Returns a range of all the style book 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.style.book.model.impl.StyleBookEntryModelImpl.

Parameters:

start - the lower bound of the range of style book entries

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

Returns:

the range of style book entries

getStyleBookEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<StyleBookEntry> getStyleBookEntries(long groupId,
                                                                                                                      int start,
                                                                                                                      int end,
                                                                                                                      OrderByComparator<StyleBookEntry> orderByComparator)

getStyleBookEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<StyleBookEntry> getStyleBookEntries(long groupId,
                                                                                                                      java.lang.String name,
                                                                                                                      int start,
                                                                                                                      int end,
                                                                                                                      OrderByComparator<StyleBookEntry> orderByComparator)

getStyleBookEntriesCount

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

Returns the number of style book entries.

Returns:

the number of style book entries

getStyleBookEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getStyleBookEntriesCount(long groupId)

getStyleBookEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getStyleBookEntriesCount(long groupId,
                                                                                                java.lang.String name)

getStyleBookEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
StyleBookEntry getStyleBookEntry(long styleBookEntryId)
                                                                                             throws PortalException

Returns the style book entry with the primary key.

Parameters:

styleBookEntryId - the primary key of the style book entry

Returns:

the style book entry

Throws:

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

getVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
StyleBookEntryVersion getVersion(StyleBookEntry styleBookEntry,
                                                                                                    int version)
                                                                                             throws PortalException

Description copied from interface: VersionService

Returns the VersionModel for the VersionedModel matching the version.

Specified by:

getVersion in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

styleBookEntry - the versioned model

version - the version

Returns:

the version model

Throws:

PortalException - if the version does not exist

getVersions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<StyleBookEntryVersion> getVersions(StyleBookEntry styleBookEntry)

Description copied from interface: VersionService

Returns the VersionModels for the VersionedModel. They are sorted in descending order.

Specified by:

getVersions in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

styleBookEntry - the versioned model

Returns:

the version models

publishDraft

@Indexable(type=REINDEX)
StyleBookEntry publishDraft(StyleBookEntry draftStyleBookEntry)
                                              throws PortalException

Description copied from interface: VersionService

Publishes the draft and creates a new version model for the new version. Any VersionServiceListener that has been registered is notified. An IllegalArgumentException is thrown if the versioned model is not a draft.

Specified by:

publishDraft in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

draftStyleBookEntry - the draft version model

Returns:

the published versioned model

Throws:

PortalException - if a portal exception occurred

registerListener

void registerListener(VersionServiceListener<StyleBookEntry,StyleBookEntryVersion> versionServiceListener)

Description copied from interface: VersionService

Registers the VersionServiceListener.

Specified by:

registerListener in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

versionServiceListener - the version service listener to register

unregisterListener

void unregisterListener(VersionServiceListener<StyleBookEntry,StyleBookEntryVersion> versionServiceListener)

Description copied from interface: VersionService

Unregisters the VersionServiceListener.

Specified by:

unregisterListener in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

versionServiceListener - the version service listener to unregister

updateDefaultStyleBookEntry

StyleBookEntry updateDefaultStyleBookEntry(long styleBookEntryId,
                                           boolean defaultStyleBookEntry)
                                    throws PortalException

Throws:

PortalException

updateDraft

@Indexable(type=REINDEX)
StyleBookEntry updateDraft(StyleBookEntry draftStyleBookEntry)
                                             throws PortalException

Description copied from interface: VersionService

Updates the draft. Any VersionServiceListener that has been registered is notified. An IllegalArgumentException is thrown if the versioned model is not a draft.

Specified by:

updateDraft in interface VersionService<StyleBookEntry,StyleBookEntryVersion>

Parameters:

draftStyleBookEntry - the draft version model

Returns:

the draft versioned model

Throws:

PortalException - if a portal exception occurred

updateFrontendTokensValues

StyleBookEntry updateFrontendTokensValues(long styleBookEntryId,
                                          java.lang.String frontendTokensValues)
                                   throws PortalException

Throws:

PortalException

updateName

StyleBookEntry updateName(long styleBookEntryId,
                          java.lang.String name)
                   throws PortalException

Throws:

PortalException

updatePreviewFileEntryId

StyleBookEntry updatePreviewFileEntryId(long styleBookEntryId,
                                        long previewFileEntryId)
                                 throws PortalException

Throws:

PortalException

updateStyleBookEntry

StyleBookEntry updateStyleBookEntry(long styleBookEntryId,
                                    java.lang.String frontendTokensValues,
                                    java.lang.String name)
                             throws PortalException

Throws:

PortalException

updateStyleBookEntry

@Indexable(type=REINDEX)
StyleBookEntry updateStyleBookEntry(StyleBookEntry draftStyleBookEntry)
                                                      throws PortalException

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

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

styleBookEntry - the style book entry

Returns:

the style book entry that was updated

Throws:

PortalException