Class StyleBookEntryLocalServiceUtil
com.liferay.style.book.service.impl.StyleBookEntryLocalServiceImpl
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 StyleBookEntry
addStyleBookEntry
(StyleBookEntry styleBookEntry) Adds the style book entry to the database.static StyleBookEntry
addStyleBookEntry
(String externalReferenceCode, long userId, long groupId, boolean defaultStyleBookEntry, String frontendTokensValues, String name, String styleBookEntryKey, String themeId, com.liferay.portal.kernel.service.ServiceContext serviceContext) static StyleBookEntry
checkout
(StyleBookEntry publishedStyleBookEntry, int version) static StyleBookEntry
copyStyleBookEntry
(long userId, long groupId, long sourceStyleBookEntryId, com.liferay.portal.kernel.service.ServiceContext serviceContext) static StyleBookEntry
create()
Creates a new style book entry.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static StyleBookEntry
delete
(StyleBookEntry publishedStyleBookEntry) static StyleBookEntry
deleteDraft
(StyleBookEntry draftStyleBookEntry) static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static void
deleteStyleBookEntries
(long groupId) static StyleBookEntry
deleteStyleBookEntry
(long styleBookEntryId) Deletes the style book entry with the primary key from the database.static StyleBookEntry
deleteStyleBookEntry
(StyleBookEntry styleBookEntry) Deletes the style book entry from the database.static StyleBookEntry
deleteStyleBookEntry
(String externalReferenceCode, long groupId) static StyleBookEntryVersion
deleteVersion
(StyleBookEntryVersion styleBookEntryVersion) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
static <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 long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.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.static StyleBookEntry
fetchDefaultStyleBookEntry
(long groupId, String themeId) static StyleBookEntry
fetchDraft
(long primaryKey) static StyleBookEntry
fetchDraft
(StyleBookEntry styleBookEntry) static StyleBookEntryVersion
fetchLatestVersion
(StyleBookEntry styleBookEntry) static StyleBookEntry
fetchPublished
(long primaryKey) static StyleBookEntry
fetchPublished
(StyleBookEntry styleBookEntry) static StyleBookEntry
fetchStyleBookEntry
(long styleBookEntryId) static StyleBookEntry
fetchStyleBookEntry
(long groupId, String styleBookEntryKey) static StyleBookEntry
fetchStyleBookEntryByUuidAndGroupId
(String uuid, long groupId) static String
generateStyleBookEntryKey
(long groupId, String name) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static StyleBookEntry
getDraft
(long primaryKey) static StyleBookEntry
getDraft
(StyleBookEntry styleBookEntry) static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static StyleBookEntryLocalService
static List<StyleBookEntry>
getStyleBookEntries
(int start, int end) Returns a range of all the style book entries.static List<StyleBookEntry>
getStyleBookEntries
(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<StyleBookEntry> orderByComparator) static List<StyleBookEntry>
getStyleBookEntries
(long groupId, String themeId) static List<StyleBookEntry>
getStyleBookEntries
(long groupId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<StyleBookEntry> orderByComparator) static List<StyleBookEntry>
getStyleBookEntriesByUuidAndCompanyId
(String uuid, long companyId) static int
Returns the number of style book entries.static int
getStyleBookEntriesCount
(long groupId) static int
getStyleBookEntriesCount
(long groupId, String name) static StyleBookEntry
getStyleBookEntry
(long styleBookEntryId) Returns the style book entry with the primary key.static StyleBookEntryVersion
getVersion
(StyleBookEntry styleBookEntry, int version) static List<StyleBookEntryVersion>
getVersions
(StyleBookEntry styleBookEntry) static StyleBookEntry
publishDraft
(StyleBookEntry draftStyleBookEntry) static void
registerListener
(com.liferay.portal.kernel.service.version.VersionServiceListener<StyleBookEntry, StyleBookEntryVersion> versionServiceListener) static void
unregisterListener
(com.liferay.portal.kernel.service.version.VersionServiceListener<StyleBookEntry, StyleBookEntryVersion> versionServiceListener) static StyleBookEntry
updateDefaultStyleBookEntry
(long styleBookEntryId, boolean defaultStyleBookEntry) static StyleBookEntry
updateDraft
(StyleBookEntry draftStyleBookEntry) static StyleBookEntry
updateFrontendTokensValues
(long styleBookEntryId, String frontendTokensValues) static StyleBookEntry
updateName
(long styleBookEntryId, String name) static StyleBookEntry
updatePreviewFileEntryId
(long styleBookEntryId, long previewFileEntryId) static StyleBookEntry
updateStyleBookEntry
(long userId, long styleBookEntryId, boolean defaultStylebookEntry, String frontendTokensValues, String name, String styleBookEntryKey, long previewFileEntryId) static StyleBookEntry
updateStyleBookEntry
(long styleBookEntryId, String frontendTokensValues, String name) static StyleBookEntry
updateStyleBookEntry
(StyleBookEntry draftStyleBookEntry) Updates the style book entry in the database or adds it if it does not yet exist.
-
Constructor Details
-
StyleBookEntryLocalServiceUtil
public StyleBookEntryLocalServiceUtil()
-
-
Method Details
-
addStyleBookEntry
public static StyleBookEntry addStyleBookEntry(String externalReferenceCode, long userId, long groupId, boolean defaultStyleBookEntry, String frontendTokensValues, String name, String styleBookEntryKey, String themeId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addStyleBookEntry
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
public static StyleBookEntry checkout(StyleBookEntry publishedStyleBookEntry, int version) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
copyStyleBookEntry
public static StyleBookEntry copyStyleBookEntry(long userId, long groupId, long sourceStyleBookEntryId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
create
Creates a new style book entry. Does not add the style book entry to the database.- Returns:
- the new style book 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
-
delete
public static StyleBookEntry delete(StyleBookEntry publishedStyleBookEntry) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteDraft
public static StyleBookEntry deleteDraft(StyleBookEntry draftStyleBookEntry) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
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
-
deleteStyleBookEntries
public static void deleteStyleBookEntries(long groupId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteStyleBookEntry
public static StyleBookEntry deleteStyleBookEntry(long styleBookEntryId) throws com.liferay.portal.kernel.exception.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:
com.liferay.portal.kernel.exception.PortalException
- if a style book entry with the primary key could not be found
-
deleteStyleBookEntry
public static StyleBookEntry deleteStyleBookEntry(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteStyleBookEntry
public static StyleBookEntry deleteStyleBookEntry(StyleBookEntry styleBookEntry) throws com.liferay.portal.kernel.exception.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:
com.liferay.portal.kernel.exception.PortalException
-
deleteVersion
public static StyleBookEntryVersion deleteVersion(StyleBookEntryVersion styleBookEntryVersion) 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.style.book.model.impl.StyleBookEntryModelImpl
.- 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.style.book.model.impl.StyleBookEntryModelImpl
.- 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
-
fetchDefaultStyleBookEntry
-
fetchDraft
-
fetchDraft
-
fetchLatestVersion
-
fetchPublished
-
fetchPublished
-
fetchStyleBookEntry
-
fetchStyleBookEntry
-
fetchStyleBookEntryByUuidAndGroupId
-
generateStyleBookEntryKey
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getDraft
public static StyleBookEntry getDraft(long primaryKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getDraft
public static StyleBookEntry getDraft(StyleBookEntry styleBookEntry) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
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
-
getStyleBookEntries
Returns a range of all the style book entries.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.style.book.model.impl.StyleBookEntryModelImpl
.- Parameters:
start
- the lower bound of the range of style book entriesend
- the upper bound of the range of style book entries (not inclusive)- Returns:
- the range of style book entries
-
getStyleBookEntries
public static List<StyleBookEntry> getStyleBookEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<StyleBookEntry> orderByComparator) -
getStyleBookEntries
-
getStyleBookEntries
public static List<StyleBookEntry> getStyleBookEntries(long groupId, String name, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<StyleBookEntry> orderByComparator) -
getStyleBookEntriesByUuidAndCompanyId
public static List<StyleBookEntry> getStyleBookEntriesByUuidAndCompanyId(String uuid, long companyId) -
getStyleBookEntriesCount
public static int getStyleBookEntriesCount()Returns the number of style book entries.- Returns:
- the number of style book entries
-
getStyleBookEntriesCount
public static int getStyleBookEntriesCount(long groupId) -
getStyleBookEntriesCount
-
getStyleBookEntry
public static StyleBookEntry getStyleBookEntry(long styleBookEntryId) throws com.liferay.portal.kernel.exception.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:
com.liferay.portal.kernel.exception.PortalException
- if a style book entry with the primary key could not be found
-
getVersion
public static StyleBookEntryVersion getVersion(StyleBookEntry styleBookEntry, int version) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getVersions
-
publishDraft
public static StyleBookEntry publishDraft(StyleBookEntry draftStyleBookEntry) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
registerListener
public static void registerListener(com.liferay.portal.kernel.service.version.VersionServiceListener<StyleBookEntry, StyleBookEntryVersion> versionServiceListener) -
unregisterListener
public static void unregisterListener(com.liferay.portal.kernel.service.version.VersionServiceListener<StyleBookEntry, StyleBookEntryVersion> versionServiceListener) -
updateDefaultStyleBookEntry
public static StyleBookEntry updateDefaultStyleBookEntry(long styleBookEntryId, boolean defaultStyleBookEntry) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateDraft
public static StyleBookEntry updateDraft(StyleBookEntry draftStyleBookEntry) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateFrontendTokensValues
public static StyleBookEntry updateFrontendTokensValues(long styleBookEntryId, String frontendTokensValues) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateName
public static StyleBookEntry updateName(long styleBookEntryId, String name) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updatePreviewFileEntryId
public static StyleBookEntry updatePreviewFileEntryId(long styleBookEntryId, long previewFileEntryId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateStyleBookEntry
public static StyleBookEntry updateStyleBookEntry(long userId, long styleBookEntryId, boolean defaultStylebookEntry, String frontendTokensValues, String name, String styleBookEntryKey, long previewFileEntryId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateStyleBookEntry
public static StyleBookEntry updateStyleBookEntry(long styleBookEntryId, String frontendTokensValues, String name) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateStyleBookEntry
public static StyleBookEntry updateStyleBookEntry(StyleBookEntry draftStyleBookEntry) throws com.liferay.portal.kernel.exception.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:
draftStyleBookEntry
- the style book entry- Returns:
- the style book entry that was updated
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-