Interface LayoutSetPrototypeLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
LayoutSetPrototypeLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddLayoutSetPrototype
(long userId, long companyId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, boolean layoutsUpdateable, boolean readyForPropagation, ServiceContext serviceContext) addLayoutSetPrototype
(long userId, long companyId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) addLayoutSetPrototype
(LayoutSetPrototype layoutSetPrototype) Adds the layout set prototype to the database.createLayoutSetPrototype
(long layoutSetPrototypeId) Creates a new layout set prototype with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteLayoutSetPrototype
(long layoutSetPrototypeId) Deletes the layout set prototype with the primary key from the database.deleteLayoutSetPrototype
(LayoutSetPrototype layoutSetPrototype) Deletes the layout set prototype from the database.void
void
deleteNondefaultLayoutSetPrototypes
(long companyId) deletePersistedModel
(PersistedModel persistedModel) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(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.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.fetchLayoutSetPrototype
(long layoutSetPrototypeId) fetchLayoutSetPrototypeByUuidAndCompanyId
(String uuid, long companyId) Returns the layout set prototype with the matching UUID and company.getExportActionableDynamicQuery
(PortletDataContext portletDataContext) getLayoutSetPrototype
(long layoutSetPrototypeId) Returns the layout set prototype with the primary key.getLayoutSetPrototypeByUuidAndCompanyId
(String uuid, long companyId) Returns the layout set prototype with the matching UUID and company.getLayoutSetPrototypes
(int start, int end) Returns a range of all the layout set prototypes.getLayoutSetPrototypes
(long companyId) int
Returns the number of layout set prototypes.Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) search
(long companyId, Boolean active, int start, int end, OrderByComparator<LayoutSetPrototype> orderByComparator) int
searchCount
(long companyId, Boolean active) updateLayoutSetPrototype
(long layoutSetPrototypeId, String settings) updateLayoutSetPrototype
(long layoutSetPrototypeId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, boolean layoutsUpdateable, boolean readyForPropagation, ServiceContext serviceContext) updateLayoutSetPrototype
(long layoutSetPrototypeId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) updateLayoutSetPrototype
(LayoutSetPrototype layoutSetPrototype) Updates the layout set prototype in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addLayoutSetPrototype
@Indexable(type=REINDEX) LayoutSetPrototype addLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype) Adds the layout set prototype to the database. Also notifies the appropriate model listeners.Important: Inspect LayoutSetPrototypeLocalServiceImpl 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:
layoutSetPrototype
- the layout set prototype- Returns:
- the layout set prototype that was added
-
addLayoutSetPrototype
LayoutSetPrototype addLayoutSetPrototype(long userId, long companyId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> descriptionMap, boolean active, boolean layoutsUpdateable, boolean readyForPropagation, ServiceContext serviceContext) - Throws:
PortalException
-
addLayoutSetPrototype
LayoutSetPrototype addLayoutSetPrototype(long userId, long companyId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) - Throws:
PortalException
-
createLayoutSetPrototype
@Transactional(enabled=false) LayoutSetPrototype createLayoutSetPrototype(long layoutSetPrototypeId) Creates a new layout set prototype with the primary key. Does not add the layout set prototype to the database.- Parameters:
layoutSetPrototypeId
- the primary key for the new layout set prototype- Returns:
- the new layout set prototype
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteLayoutSetPrototype
@Indexable(type=DELETE) @SystemEvent(action=1, type=1) LayoutSetPrototype deleteLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype) throws PortalException Deletes the layout set prototype from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutSetPrototypeLocalServiceImpl 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:
layoutSetPrototype
- the layout set prototype- Returns:
- the layout set prototype that was removed
- Throws:
PortalException
-
deleteLayoutSetPrototype
@Indexable(type=DELETE) LayoutSetPrototype deleteLayoutSetPrototype(long layoutSetPrototypeId) throws PortalException Deletes the layout set prototype with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutSetPrototypeLocalServiceImpl 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:
layoutSetPrototypeId
- the primary key of the layout set prototype- Returns:
- the layout set prototype that was removed
- Throws:
PortalException
- if a layout set prototype with the primary key could not be found
-
deleteLayoutSetPrototypes
- Throws:
PortalException
-
deleteNondefaultLayoutSetPrototypes
- Throws:
PortalException
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.LayoutSetPrototypeModelImpl
.- 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 - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.LayoutSetPrototypeModelImpl
.- 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
-
fetchLayoutSetPrototype
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSetPrototype fetchLayoutSetPrototype(long layoutSetPrototypeId) -
fetchLayoutSetPrototypeByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSetPrototype fetchLayoutSetPrototypeByUuidAndCompanyId(String uuid, long companyId) Returns the layout set prototype with the matching UUID and company.- Parameters:
uuid
- the layout set prototype's UUIDcompanyId
- the primary key of the company- Returns:
- the matching layout set prototype, or
null
if a matching layout set 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() -
getLayoutSetPrototype
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSetPrototype getLayoutSetPrototype(long layoutSetPrototypeId) throws PortalException Returns the layout set prototype with the primary key.- Parameters:
layoutSetPrototypeId
- the primary key of the layout set prototype- Returns:
- the layout set prototype
- Throws:
PortalException
- if a layout set prototype with the primary key could not be found
-
getLayoutSetPrototypeByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSetPrototype getLayoutSetPrototypeByUuidAndCompanyId(String uuid, long companyId) throws PortalException Returns the layout set prototype with the matching UUID and company.- Parameters:
uuid
- the layout set prototype's UUIDcompanyId
- the primary key of the company- Returns:
- the matching layout set prototype
- Throws:
PortalException
- if a matching layout set prototype could not be found
-
getLayoutSetPrototypes
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutSetPrototype> getLayoutSetPrototypes(int start, int end) Returns a range of all the layout set prototypes.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.LayoutSetPrototypeModelImpl
.- Parameters:
start
- the lower bound of the range of layout set prototypesend
- the upper bound of the range of layout set prototypes (not inclusive)- Returns:
- the range of layout set prototypes
-
getLayoutSetPrototypes
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutSetPrototype> getLayoutSetPrototypes(long companyId) -
getLayoutSetPrototypesCount
Returns the number of layout set prototypes.- Returns:
- the number of layout set 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 interfacePersistedModelLocalService
- Throws:
PortalException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutSetPrototype> search(long companyId, Boolean active, int start, int end, OrderByComparator<LayoutSetPrototype> orderByComparator) -
searchCount
-
updateLayoutSetPrototype
@Indexable(type=REINDEX) LayoutSetPrototype updateLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype) Updates the layout set prototype in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect LayoutSetPrototypeLocalServiceImpl 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:
layoutSetPrototype
- the layout set prototype- Returns:
- the layout set prototype that was updated
-
updateLayoutSetPrototype
LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> descriptionMap, boolean active, boolean layoutsUpdateable, boolean readyForPropagation, ServiceContext serviceContext) - Throws:
PortalException
-
updateLayoutSetPrototype
LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) - Throws:
PortalException
-
updateLayoutSetPrototype
LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, String settings) throws PortalException - Throws:
PortalException
-