com.liferay.portal.service
Interface LayoutPrototypeLocalService

All Known Implementing Classes:

LayoutPrototypeLocalServiceBaseImpl, LayoutPrototypeLocalServiceImpl, LayoutPrototypeLocalServiceWrapper

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

The interface for the layout prototype local service.

Never modify or reference this interface directly. Always use LayoutPrototypeLocalServiceUtil to access the layout prototype local service. Add custom service methods to LayoutPrototypeLocalServiceImpl 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:

LayoutPrototypeLocalServiceUtil, LayoutPrototypeLocalServiceBaseImpl, LayoutPrototypeLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

LayoutPrototype	addLayoutPrototype(LayoutPrototype layoutPrototype) Adds the layout prototype to the database.
LayoutPrototype	addLayoutPrototype(long userId, long companyId, Map<Locale,String> nameMap, String description, boolean active)
LayoutPrototype	createLayoutPrototype(long layoutPrototypeId) Creates a new layout prototype with the primary key.
void	deleteLayoutPrototype(LayoutPrototype layoutPrototype) Deletes the layout prototype from the database.
void	deleteLayoutPrototype(long layoutPrototypeId) Deletes the layout prototype with the primary key from the database.
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.
LayoutPrototype	getLayoutPrototype(long layoutPrototypeId) Gets the layout prototype with the primary key.
List<LayoutPrototype>	getLayoutPrototypes(int start, int end) Gets a range of all the layout prototypes.
int	getLayoutPrototypesCount() Gets the number of layout prototypes.
List<LayoutPrototype>	search(long companyId, Boolean active, int start, int end, OrderByComparator obc)
int	searchCount(long companyId, Boolean active)
LayoutPrototype	updateLayoutPrototype(LayoutPrototype layoutPrototype) Updates the layout prototype in the database.
LayoutPrototype	updateLayoutPrototype(LayoutPrototype layoutPrototype, boolean merge) Updates the layout prototype in the database.
LayoutPrototype	updateLayoutPrototype(long layoutPrototypeId, Map<Locale,String> nameMap, String description, boolean active)

Method Detail

addLayoutPrototype

LayoutPrototype addLayoutPrototype(LayoutPrototype layoutPrototype)
                                   throws SystemException

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

Parameters:

layoutPrototype - the layout prototype to add

Returns:

the layout prototype that was added

Throws:

SystemException - if a system exception occurred

createLayoutPrototype

LayoutPrototype createLayoutPrototype(long layoutPrototypeId)

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

Parameters:

layoutPrototypeId - the primary key for the new layout prototype

Returns:

the new layout prototype

deleteLayoutPrototype

void deleteLayoutPrototype(long layoutPrototypeId)
                           throws PortalException,
                                  SystemException

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

Parameters:

layoutPrototypeId - the primary key of the layout prototype to delete

Throws:

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

SystemException - if a system exception occurred

deleteLayoutPrototype

void deleteLayoutPrototype(LayoutPrototype layoutPrototype)
                           throws SystemException

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

Parameters:

layoutPrototype - the layout prototype 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

getLayoutPrototype

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutPrototype getLayoutPrototype(long layoutPrototypeId)
                                   throws PortalException,
                                          SystemException

Gets the layout prototype with the primary key.

Parameters:

layoutPrototypeId - the primary key of the layout prototype to get

Returns:

the layout prototype

Throws:

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

SystemException - if a system exception occurred

getLayoutPrototypes

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutPrototype> getLayoutPrototypes(int start,
                                                                                   int end)
                                          throws SystemException

Gets a range of all the layout prototypes.

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 prototypes to return

end - the upper bound of the range of layout prototypes to return (not inclusive)

Returns:

the range of layout prototypes

Throws:

SystemException - if a system exception occurred

getLayoutPrototypesCount

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

Gets the number of layout prototypes.

Returns:

the number of layout prototypes

Throws:

SystemException - if a system exception occurred

updateLayoutPrototype

LayoutPrototype updateLayoutPrototype(LayoutPrototype layoutPrototype)
                                      throws SystemException

Updates the layout prototype in the database. Also notifies the appropriate model listeners.

Parameters:

layoutPrototype - the layout prototype to update

Returns:

the layout prototype that was updated

Throws:

SystemException - if a system exception occurred

updateLayoutPrototype

LayoutPrototype updateLayoutPrototype(LayoutPrototype layoutPrototype,
                                      boolean merge)
                                      throws SystemException

Updates the layout prototype in the database. Also notifies the appropriate model listeners.

Parameters:

layoutPrototype - the layout prototype to update

merge - whether to merge the layout prototype 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 prototype that was updated

Throws:

SystemException - if a system exception occurred

addLayoutPrototype

LayoutPrototype addLayoutPrototype(long userId,
                                   long companyId,
                                   Map<Locale,String> nameMap,
                                   String description,
                                   boolean active)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutPrototype> search(long companyId,
                                                                      Boolean active,
                                                                      int start,
                                                                      int end,
                                                                      OrderByComparator obc)
                             throws SystemException

Throws:

SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         Boolean active)
                throws SystemException

Throws:

SystemException

updateLayoutPrototype

LayoutPrototype updateLayoutPrototype(long layoutPrototypeId,
                                      Map<Locale,String> nameMap,
                                      String description,
                                      boolean active)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException