com.liferay.portal.kernel.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, LayoutSetBranchLocalServiceImpl

{$generated.description}

Method Summary

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, String name, 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)
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.
LayoutSetBranch	fetchLayoutSetBranch(long layoutSetBranchId)
LayoutSetBranch	fetchLayoutSetBranch(long groupId, boolean privateLayout, String name)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
LayoutSetBranch	getLayoutSetBranch(long layoutSetBranchId) Returns the layout set branch with the primary key.
LayoutSetBranch	getLayoutSetBranch(long groupId, boolean privateLayout, String name)
List<LayoutSetBranch>	getLayoutSetBranches(long groupId, boolean privateLayout)
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)
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
LayoutSetBranch	getUserLayoutSetBranch(long userId, long groupId, boolean privateLayout, long layoutSetId, long layoutSetBranchId)
LayoutSetBranch	mergeLayoutSetBranch(long layoutSetBranchId, long mergeLayoutSetBranchId, ServiceContext serviceContext)
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, String name, String description, ServiceContext serviceContext)

Method Detail

addLayoutSetBranch

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

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

addLayoutSetBranch

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

Throws:

PortalException

createLayoutSetBranch

@Transactional(enabled=false)
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(LayoutSetBranch layoutSetBranch)
                                                       throws PortalException

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

deleteLayoutSetBranch

LayoutSetBranch deleteLayoutSetBranch(LayoutSetBranch layoutSetBranch,
                                      boolean includeMaster)
                               throws PortalException

Throws:

PortalException

deleteLayoutSetBranch

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

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

deleteLayoutSetBranches

void deleteLayoutSetBranches(long groupId,
                             boolean privateLayout)
                      throws PortalException

Throws:

PortalException

deleteLayoutSetBranches

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

Throws:

PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<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

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

dynamicQuery

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

dynamicQueryCount

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

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

fetchLayoutSetBranch

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

fetchLayoutSetBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutSetBranch fetchLayoutSetBranch(long groupId,
                                                                                                        boolean privateLayout,
                                                                                                        String name)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLayoutSetBranch

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

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

getLayoutSetBranch

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

Throws:

PortalException

getLayoutSetBranches

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutSetBranch> getLayoutSetBranches(long groupId,
                                                                                                              boolean privateLayout)

getLayoutSetBranchs

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutSetBranch> getLayoutSetBranchs(int start,
                                                                                                             int end)

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

getLayoutSetBranchsCount

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

Returns the number of layout set branchs.

Returns:

the number of layout set branchs

getMasterLayoutSetBranch

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

Throws:

PortalException

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

getUserLayoutSetBranch

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

Throws:

PortalException

mergeLayoutSetBranch

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

Throws:

PortalException

updateLayoutSetBranch

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

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

updateLayoutSetBranch

LayoutSetBranch updateLayoutSetBranch(long layoutSetBranchId,
                                      String name,
                                      String description,
                                      ServiceContext serviceContext)
                               throws PortalException

Throws:

PortalException