Liferay 6.2-ce-ga5

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

See Also:
LayoutBranchLocalServiceUtil, LayoutBranchLocalServiceBaseImpl, com.liferay.portal.service.impl.LayoutBranchLocalServiceImpl

Method Summary
 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)
           
 DynamicQuery dynamicQuery()
           
 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)
          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.
 LayoutBranch fetchLayoutBranch(long LayoutBranchId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 LayoutBranch getLayoutBranch(long LayoutBranchId)
          Returns the layout branch with the primary key.
 List<LayoutBranch> getLayoutBranches(long layoutSetBranchId, long plid, int start, int end, OrderByComparator 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)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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)
                             throws SystemException
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
Throws:
SystemException - if a system exception occurred

createLayoutBranch

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(long LayoutBranchId)
                                throws PortalException,
                                       SystemException
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
SystemException - if a system exception occurred

deleteLayoutBranch

@Indexable(type=DELETE)
LayoutBranch deleteLayoutBranch(LayoutBranch layoutBranch)
                                throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

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

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

fetchLayoutBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutBranch fetchLayoutBranch(long LayoutBranchId)
                               throws SystemException
Throws:
SystemException

getLayoutBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutBranch getLayoutBranch(long LayoutBranchId)
                             throws PortalException,
                                    SystemException
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
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getLayoutBranchs

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutBranch> getLayoutBranchs(int start,
                                                                             int end)
                                    throws SystemException
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
Throws:
SystemException - if a system exception occurred

getLayoutBranchsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutBranchsCount()
                          throws SystemException
Returns the number of layout branchs.

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

updateLayoutBranch

@Indexable(type=REINDEX)
LayoutBranch updateLayoutBranch(LayoutBranch layoutBranch)
                                throws SystemException
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
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addLayoutBranch

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

addLayoutBranch

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

deleteLayoutSetBranchLayoutBranches

void deleteLayoutSetBranchLayoutBranches(long layoutSetBranchId)
                                         throws PortalException,
                                                SystemException
Throws:
PortalException
SystemException

getLayoutBranches

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

getLayoutSetBranchLayoutBranches

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

getMasterLayoutBranch

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

getMasterLayoutBranch

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutBranch getMasterLayoutBranch(long layoutSetBranchId,
                                                                            long plid,
                                                                            ServiceContext serviceContext)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

updateLayoutBranch

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

Liferay 6.2-ce-ga5