com.liferay.portal.kernel.service

Interface LayoutSetLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

LayoutSetLocalServiceWrapper

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

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

Author:

Brian Wing Shun Chan

See Also:

LayoutSetLocalServiceUtil, LayoutSetLocalServiceBaseImpl, LayoutSetLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
LayoutSet	addLayoutSet(LayoutSet layoutSet) Adds the layout set to the database.
LayoutSet	addLayoutSet(long groupId, boolean privateLayout)
LayoutSet	createLayoutSet(long layoutSetId) Creates a new layout set with the primary key.
LayoutSet	deleteLayoutSet(LayoutSet layoutSet) Deletes the layout set from the database.
LayoutSet	deleteLayoutSet(long layoutSetId) Deletes the layout set with the primary key from the database.
void	deleteLayoutSet(long groupId, boolean privateLayout, ServiceContext serviceContext)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
DynamicQuery	dynamicQuery()
<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.
LayoutSet	fetchLayoutSet(long layoutSetId)
LayoutSet	fetchLayoutSet(String virtualHostname)
LayoutSet	fetchLayoutSetByLogoId(boolean privateLayout, long logoId)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
LayoutSet	getLayoutSet(long layoutSetId) Returns the layout set with the primary key.
LayoutSet	getLayoutSet(long groupId, boolean privateLayout)
LayoutSet	getLayoutSet(String virtualHostname)
List<LayoutSet>	getLayoutSets(int start, int end) Returns a range of all the layout sets.
List<LayoutSet>	getLayoutSetsByLayoutSetPrototypeUuid(String layoutSetPrototypeUuid)
int	getLayoutSetsCount() Returns the number of layout sets.
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
LayoutSet	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.
LayoutSet	updateLogo(long groupId, boolean privateLayout, boolean logo, byte[] bytes)
LayoutSet	updateLogo(long groupId, boolean privateLayout, boolean logo, File file)
LayoutSet	updateLogo(long groupId, boolean privateLayout, boolean logo, InputStream is)
LayoutSet	updateLogo(long groupId, boolean privateLayout, boolean logo, InputStream is, boolean cleanUpStream)
LayoutSet	updateLookAndFeel(long groupId, boolean privateLayout, String themeId, String colorSchemeId, String css)
void	updateLookAndFeel(long groupId, String themeId, String colorSchemeId, String css)
LayoutSet	updatePageCount(long groupId, boolean privateLayout)
LayoutSet	updateSettings(long groupId, boolean privateLayout, String settings)
LayoutSet	updateVirtualHost(long groupId, boolean privateLayout, String virtualHostname)

Method Detail

addLayoutSet

@Indexable(type=REINDEX)
LayoutSet addLayoutSet(LayoutSet layoutSet)

Adds the layout set to the database. Also notifies the appropriate model listeners.

Parameters:

layoutSet - the layout set

Returns:

the layout set that was added

addLayoutSet

LayoutSet addLayoutSet(long groupId,
                       boolean privateLayout)
                throws PortalException

Throws:

PortalException

createLayoutSet

@Transactional(enabled=false)
LayoutSet createLayoutSet(long layoutSetId)

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

deleteLayoutSet

@Indexable(type=DELETE)
LayoutSet deleteLayoutSet(LayoutSet layoutSet)

Deletes the layout set from the database. Also notifies the appropriate model listeners.

Parameters:

layoutSet - the layout set

Returns:

the layout set that was removed

deleteLayoutSet

@Indexable(type=DELETE)
LayoutSet deleteLayoutSet(long layoutSetId)
                                           throws PortalException

Deletes the layout set with the primary key from the database. Also notifies the appropriate model listeners.

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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery 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 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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutSetModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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> 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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutSetModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

fetchLayoutSet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSet fetchLayoutSet(long layoutSetId)

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 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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutSetModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of layout sets

end - 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int 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

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

updateLayoutSet

@Indexable(type=REINDEX)
LayoutSet updateLayoutSet(LayoutSet layoutSet)

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

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 group

privateLayout - whether the layout set is private to the group

layoutSetPrototypeLinkEnabled - whether the layout set prototype is link enabled

layoutSetPrototypeUuid - the uuid of the layout set prototype to link with

Throws:

PortalException

updateLogo

LayoutSet updateLogo(long groupId,
                     boolean privateLayout,
                     boolean logo,
                     byte[] bytes)
              throws PortalException

Throws:

PortalException

updateLogo

LayoutSet updateLogo(long groupId,
                     boolean privateLayout,
                     boolean logo,
                     File file)
              throws PortalException

Throws:

PortalException

updateLogo

LayoutSet updateLogo(long groupId,
                     boolean privateLayout,
                     boolean logo,
                     InputStream is)
              throws PortalException

Throws:

PortalException

updateLogo

LayoutSet updateLogo(long groupId,
                     boolean privateLayout,
                     boolean logo,
                     InputStream is,
                     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

updatePageCount

LayoutSet updatePageCount(long groupId,
                          boolean privateLayout)
                   throws PortalException

Throws:

PortalException

updateSettings

LayoutSet updateSettings(long groupId,
                         boolean privateLayout,
                         String settings)
                  throws PortalException

Throws:

PortalException

updateVirtualHost

LayoutSet updateVirtualHost(long groupId,
                            boolean privateLayout,
                            String virtualHostname)
                     throws PortalException

Throws:

PortalException