Liferay 6.0.5

com.liferay.portal.service
Interface LayoutSetLocalService

All Known Implementing Classes:
LayoutSetLocalServiceBaseImpl, LayoutSetLocalServiceImpl, LayoutSetLocalServiceWrapper

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

The interface for the layout set local service.

Never modify or reference this interface directly. Always use LayoutSetLocalServiceUtil to access the layout set local service. Add custom service methods to LayoutSetLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. 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:
LayoutSetLocalServiceUtil, LayoutSetLocalServiceBaseImpl, LayoutSetLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 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.
 void deleteLayoutSet(LayoutSet layoutSet)
          Deletes the layout set from the database.
 void deleteLayoutSet(long layoutSetId)
          Deletes the layout set with the primary key from the database.
 void deleteLayoutSet(long groupId, boolean privateLayout)
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Counts the number of rows that match the dynamic query.
 LayoutSet getLayoutSet(long layoutSetId)
          Gets the layout set with the primary key.
 LayoutSet getLayoutSet(long groupId, boolean privateLayout)
           
 LayoutSet getLayoutSet(String virtualHost)
           
 List<LayoutSet> getLayoutSets(int start, int end)
          Gets a range of all the layout sets.
 int getLayoutSetsCount()
          Gets the number of layout sets.
 LayoutSet updateLayoutSet(LayoutSet layoutSet)
          Updates the layout set in the database.
 LayoutSet updateLayoutSet(LayoutSet layoutSet, boolean merge)
          Updates the layout set in the database.
 void updateLogo(long groupId, boolean privateLayout, boolean logo, File file)
           
 void updateLogo(long groupId, boolean privateLayout, boolean logo, InputStream is)
           
 LayoutSet updateLookAndFeel(long groupId, boolean privateLayout, String themeId, String colorSchemeId, String css, boolean wapTheme)
           
 void updateLookAndFeel(long groupId, String themeId, String colorSchemeId, String css, boolean wapTheme)
           
 LayoutSet updatePageCount(long groupId, boolean privateLayout)
           
 LayoutSet updateSettings(long groupId, boolean privateLayout, String settings)
           
 LayoutSet updateVirtualHost(long groupId, boolean privateLayout, String virtualHost)
           
 

Method Detail

addLayoutSet

LayoutSet addLayoutSet(LayoutSet layoutSet)
                       throws SystemException
Adds the layout set to the database. Also notifies the appropriate model listeners.

Parameters:
layoutSet - the layout set to add
Returns:
the layout set that was added
Throws:
SystemException - if a system exception occurred

createLayoutSet

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

void deleteLayoutSet(long layoutSetId)
                     throws PortalException,
                            SystemException
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 to delete
Throws:
PortalException - if a layout set with the primary key could not be found
SystemException - if a system exception occurred

deleteLayoutSet

void deleteLayoutSet(LayoutSet layoutSet)
                     throws SystemException
Deletes the layout set from the database. Also notifies the appropriate model listeners.

Parameters:
layoutSet - the layout set to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getLayoutSet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSet getLayoutSet(long layoutSetId)
                       throws PortalException,
                              SystemException
Gets the layout set with the primary key.

Parameters:
layoutSetId - the primary key of the layout set to get
Returns:
the layout set
Throws:
PortalException - if a layout set with the primary key could not be found
SystemException - if a system exception occurred

getLayoutSets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutSet> getLayoutSets(int start,
                                                                       int end)
                              throws SystemException
Gets 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.

Parameters:
start - the lower bound of the range of layout sets to return
end - the upper bound of the range of layout sets to return (not inclusive)
Returns:
the range of layout sets
Throws:
SystemException - if a system exception occurred

getLayoutSetsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutSetsCount()
                       throws SystemException
Gets the number of layout sets.

Returns:
the number of layout sets
Throws:
SystemException - if a system exception occurred

updateLayoutSet

LayoutSet updateLayoutSet(LayoutSet layoutSet)
                          throws SystemException
Updates the layout set in the database. Also notifies the appropriate model listeners.

Parameters:
layoutSet - the layout set to update
Returns:
the layout set that was updated
Throws:
SystemException - if a system exception occurred

updateLayoutSet

LayoutSet updateLayoutSet(LayoutSet layoutSet,
                          boolean merge)
                          throws SystemException
Updates the layout set in the database. Also notifies the appropriate model listeners.

Parameters:
layoutSet - the layout set to update
merge - whether to merge the layout set with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the layout set that was updated
Throws:
SystemException - if a system exception occurred

addLayoutSet

LayoutSet addLayoutSet(long groupId,
                       boolean privateLayout)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

deleteLayoutSet

void deleteLayoutSet(long groupId,
                     boolean privateLayout)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

getLayoutSet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSet getLayoutSet(long groupId,
                                                                boolean privateLayout)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

getLayoutSet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSet getLayoutSet(String virtualHost)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

updateLogo

void updateLogo(long groupId,
                boolean privateLayout,
                boolean logo,
                File file)
                throws PortalException,
                       SystemException
Throws:
PortalException
SystemException

updateLogo

void updateLogo(long groupId,
                boolean privateLayout,
                boolean logo,
                InputStream is)
                throws PortalException,
                       SystemException
Throws:
PortalException
SystemException

updateLookAndFeel

void updateLookAndFeel(long groupId,
                       String themeId,
                       String colorSchemeId,
                       String css,
                       boolean wapTheme)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

updateLookAndFeel

LayoutSet updateLookAndFeel(long groupId,
                            boolean privateLayout,
                            String themeId,
                            String colorSchemeId,
                            String css,
                            boolean wapTheme)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

updatePageCount

LayoutSet updatePageCount(long groupId,
                          boolean privateLayout)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

updateSettings

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

updateVirtualHost

LayoutSet updateVirtualHost(long groupId,
                            boolean privateLayout,
                            String virtualHost)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

Liferay 6.0.5