Interface LayoutPrototypeLocalService
- All Superinterfaces:
BaseLocalService,CTService<LayoutPrototype>,PersistedModelLocalService
- All Known Implementing Classes:
LayoutPrototypeLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddLayoutPrototype(long userId, long companyId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, ServiceContext serviceContext) addLayoutPrototype(LayoutPrototype layoutPrototype) Adds the layout prototype to the database.createLayoutPrototype(long layoutPrototypeId) Creates a new layout prototype with the primary key.createPersistedModel(Serializable primaryKeyObj) deleteLayoutPrototype(long layoutPrototypeId) Deletes the layout prototype with the primary key from the database.deleteLayoutPrototype(LayoutPrototype layoutPrototype) Deletes the layout prototype from the database.voiddeleteNondefaultLayoutPrototypes(long companyId) deletePersistedModel(PersistedModel persistedModel) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.fetchLayoutPrototype(long layoutPrototypeId) fetchLayoutPrototype(long companyId, String name, Locale locale) fetchLayoutPrototypeByUuidAndCompanyId(String uuid, long companyId) Returns the layout prototype with the matching UUID and company.fetchLayoutProtoype(long companyId, String name) getExportActionableDynamicQuery(PortletDataContext portletDataContext) getLayoutPrototype(long layoutPrototypeId) Returns the layout prototype with the primary key.getLayoutPrototype(long companyId, String name) getLayoutPrototype(long companyId, String name, Locale locale) getLayoutPrototypeByUuidAndCompanyId(String uuid, long companyId) Returns the layout prototype with the matching UUID and company.getLayoutPrototypes(int start, int end) Returns a range of all the layout prototypes.intReturns the number of layout prototypes.Returns the OSGi service identifier.getPersistedModel(Serializable primaryKeyObj) search(long companyId, Boolean active, int start, int end, OrderByComparator<LayoutPrototype> orderByComparator) intsearchCount(long companyId, Boolean active) updateLayoutPrototype(long layoutPrototypeId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, ServiceContext serviceContext) updateLayoutPrototype(LayoutPrototype layoutPrototype) Updates the layout prototype in the database or adds it if it does not yet exist.<R,E extends Throwable>
RupdateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<LayoutPrototype>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addLayoutPrototype
Adds the layout prototype to the database. Also notifies the appropriate model listeners.Important: Inspect LayoutPrototypeLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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, throws PortalExceptionString> descriptionMap, boolean active, ServiceContext serviceContext) - Throws:
PortalException
-
createLayoutPrototype
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
-
createPersistedModel
- Specified by:
createPersistedModelin interfacePersistedModelLocalService- Throws:
PortalException
-
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.Important: Inspect LayoutPrototypeLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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.Important: Inspect LayoutPrototypeLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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
- Throws:
PortalException
-
deletePersistedModel
- Specified by:
deletePersistedModelin interfacePersistedModelLocalService- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacePersistedModelLocalService
-
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.LayoutPrototypeModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.LayoutPrototypeModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- 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 queryprojection- 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) -
fetchLayoutPrototype
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutPrototype fetchLayoutPrototype(long companyId, String name, Locale locale) -
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 UUIDcompanyId- the primary key of the company- Returns:
- the matching layout prototype, or
nullif a matching layout prototype could not be found
-
fetchLayoutProtoype
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutPrototype fetchLayoutProtoype(long companyId, String name) -
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
-
getLayoutPrototype
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutPrototype getLayoutPrototype(long companyId, String name) throws PortalException - Throws:
PortalException
-
getLayoutPrototype
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutPrototype getLayoutPrototype(long companyId, String name, Locale locale) throws PortalException - Throws:
PortalException
-
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 UUIDcompanyId- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.LayoutPrototypeModelImpl.- Parameters:
start- the lower bound of the range of layout prototypesend- the upper bound of the range of layout prototypes (not inclusive)- Returns:
- the range of layout prototypes
-
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:
getPersistedModelin interfacePersistedModelLocalService- Throws:
PortalException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutPrototype> search(long companyId, Boolean active, int start, int end, OrderByComparator<LayoutPrototype> orderByComparator) -
searchCount
-
updateLayoutPrototype
Updates the layout prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect LayoutPrototypeLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
layoutPrototype- the layout prototype- Returns:
- the layout prototype that was updated
-
updateLayoutPrototype
LayoutPrototype updateLayoutPrototype(long layoutPrototypeId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> descriptionMap, boolean active, ServiceContext serviceContext) - Throws:
PortalException
-
getCTPersistence
- Specified by:
getCTPersistencein interfaceCTService<LayoutPrototype>
-
getModelClass
- Specified by:
getModelClassin interfaceCTService<LayoutPrototype>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<LayoutPrototype>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunctionin interfaceCTService<LayoutPrototype>- Throws:
E extends Throwable
-