com.liferay.portal.kernel.service

Interface LayoutBranchLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

LayoutBranchLocalServiceWrapper

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

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

LayoutBranchLocalServiceUtil, LayoutBranchLocalServiceBaseImpl, LayoutBranchLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
LayoutBranch	addLayoutBranch(LayoutBranch layoutBranch) Adds the layout branch to the database.
LayoutBranch	addLayoutBranch(long layoutSetBranchId, long plid, String name, String description, boolean master, ServiceContext serviceContext)
LayoutBranch	addLayoutBranch(long layoutRevisionId, String name, String description, boolean master, ServiceContext serviceContext)
LayoutBranch	createLayoutBranch(long layoutBranchId) Creates a new layout branch with the primary key.
LayoutBranch	deleteLayoutBranch(LayoutBranch layoutBranch) Deletes the layout branch from the database.
LayoutBranch	deleteLayoutBranch(long layoutBranchId) Deletes the layout branch with the primary key from the database.
void	deleteLayoutSetBranchLayoutBranches(long layoutSetBranchId)
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.
LayoutBranch	fetchLayoutBranch(long layoutBranchId)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
LayoutBranch	getLayoutBranch(long layoutBranchId) Returns the layout branch with the primary key.
List<LayoutBranch>	getLayoutBranches(long layoutSetBranchId, long plid, int start, int end, OrderByComparator<LayoutBranch> orderByComparator)
List<LayoutBranch>	getLayoutBranchs(int start, int end) Returns a range of all the layout branchs.
int	getLayoutBranchsCount() Returns the number of layout branchs.
List<LayoutBranch>	getLayoutSetBranchLayoutBranches(long layoutSetBranchId)
LayoutBranch	getMasterLayoutBranch(long layoutSetBranchId, long plid)
LayoutBranch	getMasterLayoutBranch(long layoutSetBranchId, long plid, ServiceContext serviceContext)
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
LayoutBranch	updateLayoutBranch(LayoutBranch layoutBranch) Updates the layout branch in the database or adds it if it does not yet exist.
LayoutBranch	updateLayoutBranch(long layoutBranchId, String name, String description, ServiceContext serviceContext)

Method Detail

addLayoutBranch

@Indexable(type=REINDEX)
LayoutBranch addLayoutBranch(LayoutBranch layoutBranch)

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

Parameters:

layoutBranch - the layout branch

Returns:

the layout branch that was added

addLayoutBranch

LayoutBranch addLayoutBranch(long layoutSetBranchId,
                             long plid,
                             String name,
                             String description,
                             boolean master,
                             ServiceContext serviceContext)
                      throws PortalException

Throws:

PortalException

addLayoutBranch

LayoutBranch addLayoutBranch(long layoutRevisionId,
                             String name,
                             String description,
                             boolean master,
                             ServiceContext serviceContext)
                      throws PortalException

Throws:

PortalException

createLayoutBranch

@Transactional(enabled=false)
LayoutBranch createLayoutBranch(long layoutBranchId)

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

Parameters:

layoutBranchId - the primary key for the new layout branch

Returns:

the new layout branch

deleteLayoutBranch

@Indexable(type=DELETE)
LayoutBranch deleteLayoutBranch(LayoutBranch layoutBranch)

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

Parameters:

layoutBranch - the layout branch

Returns:

the layout branch that was removed

deleteLayoutBranch

@Indexable(type=DELETE)
LayoutBranch deleteLayoutBranch(long layoutBranchId)
                                                 throws PortalException

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

Parameters:

layoutBranchId - the primary key of the layout branch

Returns:

the layout branch that was removed

Throws:

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

deleteLayoutSetBranchLayoutBranches

void deleteLayoutSetBranchLayoutBranches(long layoutSetBranchId)
                                  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 LayoutBranchModelImpl. 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 LayoutBranchModelImpl. 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

fetchLayoutBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutBranch fetchLayoutBranch(long layoutBranchId)

getActionableDynamicQuery

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

getIndexableActionableDynamicQuery

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

getLayoutBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutBranch getLayoutBranch(long layoutBranchId)
                                                                                         throws PortalException

Returns the layout branch with the primary key.

Parameters:

layoutBranchId - the primary key of the layout branch

Returns:

the layout branch

Throws:

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

getLayoutBranches

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutBranch> getLayoutBranches(long layoutSetBranchId,
                                                                                                        long plid,
                                                                                                        int start,
                                                                                                        int end,
                                                                                                        OrderByComparator<LayoutBranch> orderByComparator)

getLayoutBranchs

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

Returns a range of all the layout 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 LayoutBranchModelImpl. 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 branchs

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

Returns:

the range of layout branchs

getLayoutBranchsCount

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

Returns the number of layout branchs.

Returns:

the number of layout branchs

getLayoutSetBranchLayoutBranches

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutBranch> getLayoutSetBranchLayoutBranches(long layoutSetBranchId)

getMasterLayoutBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutBranch getMasterLayoutBranch(long layoutSetBranchId,
                                                                                                      long plid)
                                                                                               throws PortalException

Throws:

PortalException

getMasterLayoutBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutBranch getMasterLayoutBranch(long layoutSetBranchId,
                                                                                                      long plid,
                                                                                                      ServiceContext serviceContext)
                                                                                               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

updateLayoutBranch

@Indexable(type=REINDEX)
LayoutBranch updateLayoutBranch(LayoutBranch layoutBranch)

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

Parameters:

layoutBranch - the layout branch

Returns:

the layout branch that was updated

updateLayoutBranch

LayoutBranch updateLayoutBranch(long layoutBranchId,
                                String name,
                                String description,
                                ServiceContext serviceContext)
                         throws PortalException

Throws:

PortalException