com.liferay.portal.service
Interface LayoutPrototypeLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

LayoutPrototypeLocalServiceWrapper

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

Provides the local service interface for LayoutPrototype. 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, com.liferay.portal.service.impl.LayoutPrototypeLocalServiceImpl

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) Deprecated. As of 6.2.0, replaced by addLayoutPrototype(long, long, Map, String, boolean, ServiceContext)
LayoutPrototype	addLayoutPrototype(long userId, long companyId, Map<Locale,String> nameMap, String description, boolean active, ServiceContext serviceContext)
LayoutPrototype	createLayoutPrototype(long layoutPrototypeId) Creates a new layout prototype with the primary key.
LayoutPrototype	deleteLayoutPrototype(LayoutPrototype layoutPrototype) Deletes the layout prototype from the database.
LayoutPrototype	deleteLayoutPrototype(long layoutPrototypeId) Deletes the layout prototype with the primary key from the database.
void	deleteNondefaultLayoutPrototypes(long companyId)
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.
LayoutPrototype	fetchLayoutPrototype(long layoutPrototypeId)
LayoutPrototype	fetchLayoutPrototypeByUuidAndCompanyId(String uuid, long companyId) Returns the layout prototype with the matching UUID and company.
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
LayoutPrototype	getLayoutPrototype(long layoutPrototypeId) Returns the layout prototype with the primary key.
LayoutPrototype	getLayoutPrototypeByUuid(String uuid) Deprecated. As of 6.2.0, replaced by getLayoutPrototypeByUuidAndCompanyId(String, long)
LayoutPrototype	getLayoutPrototypeByUuidAndCompanyId(String uuid, long companyId) Returns the layout prototype with the matching UUID and company.
List<LayoutPrototype>	getLayoutPrototypes(int start, int end) Returns a range of all the layout prototypes.
int	getLayoutPrototypesCount() Returns the number of layout prototypes.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<LayoutPrototype>	search(long companyId, Boolean active, int start, int end, OrderByComparator obc)
int	searchCount(long companyId, Boolean active)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
LayoutPrototype	updateLayoutPrototype(LayoutPrototype layoutPrototype) Updates the layout prototype in the database or adds it if it does not yet exist.
LayoutPrototype	updateLayoutPrototype(long layoutPrototypeId, Map<Locale,String> nameMap, String description, boolean active) Deprecated. As of 6.2.0, replaced by updateLayoutPrototype(long, Map, String, boolean, ServiceContext)
LayoutPrototype	updateLayoutPrototype(long layoutPrototypeId, Map<Locale,String> nameMap, String description, boolean active, ServiceContext serviceContext)

Method Detail

addLayoutPrototype

@Indexable(type=REINDEX)
LayoutPrototype addLayoutPrototype(LayoutPrototype layoutPrototype)
                                   throws SystemException

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

Parameters:

layoutPrototype - the layout prototype

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

@Indexable(type=DELETE)
LayoutPrototype 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

Returns:

the layout prototype that was removed

Throws:

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

SystemException - if a system exception occurred

deleteLayoutPrototype

@Indexable(type=DELETE)
LayoutPrototype deleteLayoutPrototype(LayoutPrototype layoutPrototype)
                                      throws PortalException,
                                             SystemException

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

Parameters:

layoutPrototype - the layout prototype

Returns:

the layout prototype that was removed

Throws:

PortalException

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

fetchLayoutPrototype

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

Throws:

SystemException

fetchLayoutPrototypeByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutPrototype fetchLayoutPrototypeByUuidAndCompanyId(String uuid,
                                                                                                long companyId)
                                                       throws SystemException

Returns the layout prototype with the matching UUID and company.

Parameters:

uuid - the layout prototype's UUID

companyId - the primary key of the company

Returns:

the matching layout prototype, or null if a matching layout prototype could not be found

Throws:

SystemException - if a system exception occurred

getLayoutPrototype

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

Returns the layout prototype with the primary key.

Parameters:

layoutPrototypeId - the primary key of the layout prototype

Returns:

the layout prototype

Throws:

PortalException - if a layout prototype 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

getLayoutPrototypeByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutPrototype getLayoutPrototypeByUuidAndCompanyId(String uuid,
                                                                                              long companyId)
                                                     throws PortalException,
                                                            SystemException

Returns the layout prototype with the matching UUID and company.

Parameters:

uuid - the layout prototype's UUID

companyId - the primary key of the company

Returns:

the matching layout prototype

Throws:

PortalException - if a matching layout prototype 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

Returns 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. 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 LayoutPrototypeModelImpl. 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 prototypes

end - the upper bound of the range of layout prototypes (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

Returns the number of layout prototypes.

Returns:

the number of layout prototypes

Throws:

SystemException - if a system exception occurred

updateLayoutPrototype

@Indexable(type=REINDEX)
LayoutPrototype updateLayoutPrototype(LayoutPrototype layoutPrototype)
                                      throws SystemException

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

Parameters:

layoutPrototype - the layout prototype

Returns:

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

addLayoutPrototype

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

Deprecated. As of 6.2.0, replaced by addLayoutPrototype(long, long, Map, String, boolean, ServiceContext)

Throws:

PortalException

SystemException

addLayoutPrototype

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

Throws:

PortalException

SystemException

deleteNondefaultLayoutPrototypes

void deleteNondefaultLayoutPrototypes(long companyId)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

getLayoutPrototypeByUuid

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutPrototype getLayoutPrototypeByUuid(String uuid)
                                         throws PortalException,
                                                SystemException

Deprecated. As of 6.2.0, replaced by getLayoutPrototypeByUuidAndCompanyId(String, long)

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

Deprecated. As of 6.2.0, replaced by updateLayoutPrototype(long, Map, String, boolean, ServiceContext)

Throws:

PortalException

SystemException

updateLayoutPrototype

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

Throws:

PortalException

SystemException