Interface LayoutSetLocalService
- All Superinterfaces:
BaseLocalService
,CTService<LayoutSet>
,PersistedModelLocalService
- All Known Implementing Classes:
LayoutSetLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddLayoutSet
(long groupId, boolean privateLayout) addLayoutSet
(LayoutSet layoutSet) Adds the layout set to the database.createLayoutSet
(long layoutSetId) Creates a new layout set with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteLayoutSet
(long layoutSetId) Deletes the layout set with the primary key from the database.void
deleteLayoutSet
(long groupId, boolean privateLayout, ServiceContext serviceContext) deleteLayoutSet
(LayoutSet layoutSet) Deletes the layout set from the database.deletePersistedModel
(PersistedModel persistedModel) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> 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> 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.fetchLayoutSet
(long layoutSetId) fetchLayoutSet
(long groupId, boolean privateLayout) fetchLayoutSet
(String virtualHostname) fetchLayoutSetByLogoId
(boolean privateLayout, long logoId) getLayoutSet
(long layoutSetId) Returns the layout set with the primary key.getLayoutSet
(long groupId, boolean privateLayout) getLayoutSet
(String virtualHostname) getLayoutSets
(int start, int end) Returns a range of all the layout sets.getLayoutSetsByLayoutSetPrototypeUuid
(String layoutSetPrototypeUuid) int
Returns the number of layout sets.Returns the OSGi service identifier.int
getPageCount
(long groupId, boolean privateLayout) getPersistedModel
(Serializable primaryKeyObj) updateFaviconFileEntryId
(long groupId, boolean privateLayout, long faviconFileEntryId) updateLayoutSet
(LayoutSet layoutSet) Updates the layout set in the database or adds it if it does not yet exist.void
updateLayoutSetPrototypeLinkEnabled
(long groupId, boolean privateLayout, boolean layoutSetPrototypeLinkEnabled, String layoutSetPrototypeUuid) Updates the state of the layout set prototype link.updateLogo
(long groupId, boolean privateLayout, boolean hasLogo, byte[] bytes) updateLogo
(long groupId, boolean privateLayout, boolean hasLogo, File file) updateLogo
(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream) updateLogo
(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream, boolean cleanUpStream) updateLookAndFeel
(long groupId, boolean privateLayout, String themeId, String colorSchemeId, String css) void
updateLookAndFeel
(long groupId, String themeId, String colorSchemeId, String css) updateSettings
(long groupId, boolean privateLayout, String settings) updateVirtualHosts
(long groupId, boolean privateLayout, TreeMap<String, String> virtualHostnames) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<LayoutSet>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addLayoutSet
Adds the layout set to the database. Also notifies the appropriate model listeners.Important: Inspect LayoutSetLocalServiceImpl 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:
layoutSet
- the layout set- Returns:
- the layout set that was added
-
addLayoutSet
- Throws:
PortalException
-
createLayoutSet
Creates a new layout set with the primary key. Does not add the layout set to the database.- Parameters:
layoutSetId
- the primary key for the new layout set- Returns:
- the new layout set
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteLayoutSet
Deletes the layout set from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutSetLocalServiceImpl 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:
layoutSet
- the layout set- Returns:
- the layout set that was removed
-
deleteLayoutSet
Deletes the layout set with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutSetLocalServiceImpl 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:
layoutSetId
- the primary key of the layout set- Returns:
- the layout set that was removed
- Throws:
PortalException
- if a layout set with the primary key could not be found
-
deleteLayoutSet
void deleteLayoutSet(long groupId, boolean privateLayout, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> 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> 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
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.portal.model.impl.LayoutSetModelImpl
.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) <T> 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
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.portal.model.impl.LayoutSetModelImpl
.- 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
@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 queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchLayoutSet
-
fetchLayoutSet
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet fetchLayoutSet(long groupId, boolean privateLayout) -
fetchLayoutSet
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet fetchLayoutSet(String virtualHostname) -
fetchLayoutSetByLogoId
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet fetchLayoutSetByLogoId(boolean privateLayout, long logoId) throws PortalException - Throws:
PortalException
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getLayoutSet
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet getLayoutSet(long layoutSetId) throws PortalException Returns the layout set with the primary key.- Parameters:
layoutSetId
- the primary key of the layout set- Returns:
- the layout set
- Throws:
PortalException
- if a layout set with the primary key could not be found
-
getLayoutSet
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet getLayoutSet(long groupId, boolean privateLayout) throws PortalException - Throws:
PortalException
-
getLayoutSet
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSet getLayoutSet(String virtualHostname) throws PortalException - Throws:
PortalException
-
getLayoutSets
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutSet> getLayoutSets(int start, int end) Returns a range of all the layout sets.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.portal.model.impl.LayoutSetModelImpl
.- Parameters:
start
- the lower bound of the range of layout setsend
- the upper bound of the range of layout sets (not inclusive)- Returns:
- the range of layout sets
-
getLayoutSetsByLayoutSetPrototypeUuid
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutSet> getLayoutSetsByLayoutSetPrototypeUuid(String layoutSetPrototypeUuid) -
getLayoutSetsCount
Returns the number of layout sets.- Returns:
- the number of layout sets
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPageCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getPageCount(long groupId, boolean privateLayout) -
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
updateFaviconFileEntryId
LayoutSet updateFaviconFileEntryId(long groupId, boolean privateLayout, long faviconFileEntryId) throws PortalException - Throws:
PortalException
-
updateLayoutSet
Updates the layout set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect LayoutSetLocalServiceImpl 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:
layoutSet
- the layout set- Returns:
- the layout set that was updated
-
updateLayoutSetPrototypeLinkEnabled
void updateLayoutSetPrototypeLinkEnabled(long groupId, boolean privateLayout, boolean layoutSetPrototypeLinkEnabled, String layoutSetPrototypeUuid) throws PortalException Updates the state of the layout set prototype link.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout set is private to the grouplayoutSetPrototypeLinkEnabled
- whether the layout set prototype is link enabledlayoutSetPrototypeUuid
- the uuid of the layout set prototype to link with- Throws:
PortalException
-
updateLogo
LayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, byte[] bytes) throws PortalException - Throws:
PortalException
-
updateLogo
LayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, File file) throws PortalException - Throws:
PortalException
-
updateLogo
LayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream) throws PortalException - Throws:
PortalException
-
updateLogo
LayoutSet updateLogo(long groupId, boolean privateLayout, boolean hasLogo, InputStream inputStream, boolean cleanUpStream) throws PortalException - Throws:
PortalException
-
updateLookAndFeel
LayoutSet updateLookAndFeel(long groupId, boolean privateLayout, String themeId, String colorSchemeId, String css) throws PortalException - Throws:
PortalException
-
updateLookAndFeel
void updateLookAndFeel(long groupId, String themeId, String colorSchemeId, String css) throws PortalException - Throws:
PortalException
-
updateSettings
LayoutSet updateSettings(long groupId, boolean privateLayout, String settings) throws PortalException - Throws:
PortalException
-
updateVirtualHosts
LayoutSet updateVirtualHosts(long groupId, boolean privateLayout, TreeMap<String, String> virtualHostnames) throws PortalException- Throws:
PortalException
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<LayoutSet>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<LayoutSet>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<LayoutSet>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<LayoutSet>
- Throws:
E extends Throwable
-