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

Author:

Brian Wing Shun Chan

See Also:

LayoutPrototypeLocalServiceUtil, LayoutPrototypeLocalServiceBaseImpl, LayoutPrototypeLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
LayoutPrototype	addLayoutPrototype(LayoutPrototype layoutPrototype) Adds the layout prototype to the database.
LayoutPrototype	addLayoutPrototype(long userId, long companyId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, boolean active, ServiceContext serviceContext)
LayoutPrototype	addLayoutPrototype(long userId, long companyId, Map<Locale,String> nameMap, String description, boolean active, ServiceContext serviceContext) Deprecated. As of Wilberforce (7.0.x), replaced by addLayoutPrototype(long, long, Map, Map, boolean, 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)
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.
LayoutPrototype	fetchLayoutPrototype(long layoutPrototypeId)
LayoutPrototype	fetchLayoutPrototypeByUuidAndCompanyId(String uuid, long companyId) Returns the layout prototype with the matching UUID and company.
ActionableDynamicQuery	getActionableDynamicQuery()
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
LayoutPrototype	getLayoutPrototype(long layoutPrototypeId) Returns the layout prototype with the primary key.
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.
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<LayoutPrototype>	search(long companyId, Boolean active, int start, int end, OrderByComparator<LayoutPrototype> obc)
int	searchCount(long companyId, Boolean active)
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, Map<Locale,String> descriptionMap, boolean active, ServiceContext serviceContext)
LayoutPrototype	updateLayoutPrototype(long layoutPrototypeId, Map<Locale,String> nameMap, String description, boolean active, ServiceContext serviceContext) Deprecated. As of Wilberforce (7.0.x), replaced by updateLayoutPrototype(long, Map, Map, boolean, ServiceContext)

Method Detail

addLayoutPrototype

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

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

addLayoutPrototype

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

Throws:

PortalException

addLayoutPrototype

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

Deprecated. As of Wilberforce (7.0.x), replaced by addLayoutPrototype(long, long, Map, Map, boolean, ServiceContext)

Throws:

PortalException

createLayoutPrototype

@Transactional(enabled=false)
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)
 @SystemEvent(action=1,
             type=1)
LayoutPrototype deleteLayoutPrototype(LayoutPrototype layoutPrototype)
                                                                                                    throws PortalException

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

deleteLayoutPrototype

@Indexable(type=DELETE)
LayoutPrototype deleteLayoutPrototype(long layoutPrototypeId)
                                                       throws PortalException

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

deleteNondefaultLayoutPrototypes

void deleteNondefaultLayoutPrototypes(long companyId)
                               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 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

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

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

fetchLayoutPrototype

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

fetchLayoutPrototypeByUuidAndCompanyId

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

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

getActionableDynamicQuery

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

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

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

getLayoutPrototype

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

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

getLayoutPrototypeByUuidAndCompanyId

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

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

getLayoutPrototypes

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

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

getLayoutPrototypesCount

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

Returns the number of layout prototypes.

Returns:

the number of layout prototypes

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

search

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

searchCount

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

updateLayoutPrototype

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

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

updateLayoutPrototype

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

Throws:

PortalException

updateLayoutPrototype

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

Deprecated. As of Wilberforce (7.0.x), replaced by updateLayoutPrototype(long, Map, Map, boolean, ServiceContext)

Throws:

PortalException