com.liferay.portal.service

Interface LayoutSetBranchLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

LayoutSetBranchLocalServiceWrapper

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

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

LayoutSetBranchLocalServiceUtil, LayoutSetBranchLocalServiceBaseImpl, com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
LayoutSetBranch	addLayoutSetBranch(LayoutSetBranch layoutSetBranch) Adds the layout set branch to the database.
LayoutSetBranch	addLayoutSetBranch(long userId, long groupId, boolean privateLayout, java.lang.String name, java.lang.String description, boolean master, long copyLayoutSetBranchId, ServiceContext serviceContext)
LayoutSetBranch	createLayoutSetBranch(long layoutSetBranchId) Creates a new layout set branch with the primary key.
LayoutSetBranch	deleteLayoutSetBranch(LayoutSetBranch layoutSetBranch) Deletes the layout set branch from the database.
LayoutSetBranch	deleteLayoutSetBranch(LayoutSetBranch layoutSetBranch, boolean includeMaster)
LayoutSetBranch	deleteLayoutSetBranch(long layoutSetBranchId) Deletes the layout set branch with the primary key from the database.
void	deleteLayoutSetBranches(long groupId, boolean privateLayout)
void	deleteLayoutSetBranches(long groupId, boolean privateLayout, boolean includeMaster)
DynamicQuery	dynamicQuery()
java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
java.util.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) Returns the number of rows that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
LayoutSetBranch	fetchLayoutSetBranch(long layoutSetBranchId)
LayoutSetBranch	fetchLayoutSetBranch(long groupId, boolean privateLayout, java.lang.String name)
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
LayoutSetBranch	getLayoutSetBranch(long layoutSetBranchId) Returns the layout set branch with the primary key.
LayoutSetBranch	getLayoutSetBranch(long groupId, boolean privateLayout, java.lang.String name)
java.util.List<LayoutSetBranch>	getLayoutSetBranches(long groupId, boolean privateLayout)
java.util.List<LayoutSetBranch>	getLayoutSetBranchs(int start, int end) Returns a range of all the layout set branchs.
int	getLayoutSetBranchsCount() Returns the number of layout set branchs.
LayoutSetBranch	getMasterLayoutSetBranch(long groupId, boolean privateLayout)
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
LayoutSetBranch	getUserLayoutSetBranch(long userId, long groupId, boolean privateLayout, long layoutSetBranchId) Deprecated. As of 6.2.0, replaced by getUserLayoutSetBranch(long, long, boolean, long, long)
LayoutSetBranch	getUserLayoutSetBranch(long userId, long groupId, boolean privateLayout, long layoutSetId, long layoutSetBranchId)
LayoutSetBranch	mergeLayoutSetBranch(long layoutSetBranchId, long mergeLayoutSetBranchId, ServiceContext serviceContext)
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
LayoutSetBranch	updateLayoutSetBranch(LayoutSetBranch layoutSetBranch) Updates the layout set branch in the database or adds it if it does not yet exist.
LayoutSetBranch	updateLayoutSetBranch(long layoutSetBranchId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)

Method Detail

addLayoutSetBranch

@Indexable(type=REINDEX)
LayoutSetBranch addLayoutSetBranch(LayoutSetBranch layoutSetBranch)
                                   throws SystemException

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

Parameters:

layoutSetBranch - the layout set branch

Returns:

the layout set branch that was added

Throws:

SystemException - if a system exception occurred

createLayoutSetBranch

LayoutSetBranch createLayoutSetBranch(long layoutSetBranchId)

Creates a new layout set branch with the primary key. Does not add the layout set branch to the database.

Parameters:

layoutSetBranchId - the primary key for the new layout set branch

Returns:

the new layout set branch

deleteLayoutSetBranch

@Indexable(type=DELETE)
LayoutSetBranch deleteLayoutSetBranch(long layoutSetBranchId)
                                      throws PortalException,
                                             SystemException

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

Parameters:

layoutSetBranchId - the primary key of the layout set branch

Returns:

the layout set branch that was removed

Throws:

PortalException - if a layout set branch with the primary key could not be found

SystemException - if a system exception occurred

deleteLayoutSetBranch

@Indexable(type=DELETE)
LayoutSetBranch deleteLayoutSetBranch(LayoutSetBranch layoutSetBranch)
                                      throws PortalException,
                                             SystemException

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

Parameters:

layoutSetBranch - the layout set branch

Returns:

the layout set branch that was removed

Throws:

PortalException

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                            throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

java.util.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. 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 LayoutSetBranchModelImpl. 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

Throws:

SystemException - if a system exception occurred

dynamicQuery

java.util.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. 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 LayoutSetBranchModelImpl. 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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchLayoutSetBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetBranch fetchLayoutSetBranch(long layoutSetBranchId)
                                     throws SystemException

Throws:

SystemException

getLayoutSetBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetBranch getLayoutSetBranch(long layoutSetBranchId)
                                   throws PortalException,
                                          SystemException

Returns the layout set branch with the primary key.

Parameters:

layoutSetBranchId - the primary key of the layout set branch

Returns:

the layout set branch

Throws:

PortalException - if a layout set branch with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getLayoutSetBranchs

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<LayoutSetBranch> getLayoutSetBranchs(int start,
                                                                                           int end)
                                                    throws SystemException

Returns a range of all the layout set branchs.

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 LayoutSetBranchModelImpl. 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 set branchs

end - the upper bound of the range of layout set branchs (not inclusive)

Returns:

the range of layout set branchs

Throws:

SystemException - if a system exception occurred

getLayoutSetBranchsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutSetBranchsCount()
                             throws SystemException

Returns the number of layout set branchs.

Returns:

the number of layout set branchs

Throws:

SystemException - if a system exception occurred

updateLayoutSetBranch

@Indexable(type=REINDEX)
LayoutSetBranch updateLayoutSetBranch(LayoutSetBranch layoutSetBranch)
                                      throws SystemException

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

Parameters:

layoutSetBranch - the layout set branch

Returns:

the layout set branch that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addLayoutSetBranch

LayoutSetBranch addLayoutSetBranch(long userId,
                                 long groupId,
                                 boolean privateLayout,
                                 java.lang.String name,
                                 java.lang.String description,
                                 boolean master,
                                 long copyLayoutSetBranchId,
                                 ServiceContext serviceContext)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

deleteLayoutSetBranch

LayoutSetBranch deleteLayoutSetBranch(LayoutSetBranch layoutSetBranch,
                                    boolean includeMaster)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

deleteLayoutSetBranches

void deleteLayoutSetBranches(long groupId,
                           boolean privateLayout)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

deleteLayoutSetBranches

void deleteLayoutSetBranches(long groupId,
                           boolean privateLayout,
                           boolean includeMaster)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

fetchLayoutSetBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetBranch fetchLayoutSetBranch(long groupId,
                                                                            boolean privateLayout,
                                                                            java.lang.String name)
                                     throws SystemException

Throws:

SystemException

getLayoutSetBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetBranch getLayoutSetBranch(long groupId,
                                                                          boolean privateLayout,
                                                                          java.lang.String name)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getLayoutSetBranches

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<LayoutSetBranch> getLayoutSetBranches(long groupId,
                                                                                            boolean privateLayout)
                                                     throws SystemException

Throws:

SystemException

getMasterLayoutSetBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetBranch getMasterLayoutSetBranch(long groupId,
                                                                                boolean privateLayout)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

getUserLayoutSetBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetBranch getUserLayoutSetBranch(long userId,
                                                                              long groupId,
                                                                              boolean privateLayout,
                                                                              long layoutSetBranchId)
                                       throws PortalException,
                                              SystemException

Deprecated. As of 6.2.0, replaced by getUserLayoutSetBranch(long, long, boolean, long, long)

Throws:

PortalException

SystemException

getUserLayoutSetBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetBranch getUserLayoutSetBranch(long userId,
                                                                              long groupId,
                                                                              boolean privateLayout,
                                                                              long layoutSetId,
                                                                              long layoutSetBranchId)
                                       throws PortalException,
                                              SystemException

Throws:

PortalException

SystemException

mergeLayoutSetBranch

LayoutSetBranch mergeLayoutSetBranch(long layoutSetBranchId,
                                   long mergeLayoutSetBranchId,
                                   ServiceContext serviceContext)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

updateLayoutSetBranch

LayoutSetBranch updateLayoutSetBranch(long layoutSetBranchId,
                                    java.lang.String name,
                                    java.lang.String description,
                                    ServiceContext serviceContext)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException