Class LayoutPrototypeLocalServiceUtil
com.liferay.portal.service.impl.LayoutPrototypeLocalServiceImpl and
is an access point for service operations in application layer code running
on the local server. 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:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic LayoutPrototypeaddLayoutPrototype(long userId, long companyId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, ServiceContext serviceContext) static LayoutPrototypeaddLayoutPrototype(LayoutPrototype layoutPrototype) Adds the layout prototype to the database.static LayoutPrototypecreateLayoutPrototype(long layoutPrototypeId) Creates a new layout prototype with the primary key.static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static LayoutPrototypedeleteLayoutPrototype(long layoutPrototypeId) Deletes the layout prototype with the primary key from the database.static LayoutPrototypedeleteLayoutPrototype(LayoutPrototype layoutPrototype) Deletes the layout prototype from the database.static voiddeleteNondefaultLayoutPrototypes(long companyId) static PersistedModeldeletePersistedModel(PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuerystatic <T> List<T>dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static LayoutPrototypefetchLayoutPrototype(long layoutPrototypeId) static LayoutPrototypefetchLayoutPrototype(long companyId, String name, Locale locale) static LayoutPrototypefetchLayoutPrototypeByUuidAndCompanyId(String uuid, long companyId) Returns the layout prototype with the matching UUID and company.static LayoutPrototypefetchLayoutProtoype(long companyId, String name) static ActionableDynamicQuerystatic ExportActionableDynamicQuerygetExportActionableDynamicQuery(PortletDataContext portletDataContext) static LayoutPrototypegetLayoutPrototype(long layoutPrototypeId) Returns the layout prototype with the primary key.static LayoutPrototypegetLayoutPrototype(long companyId, String name) static LayoutPrototypegetLayoutPrototype(long companyId, String name, Locale locale) static LayoutPrototypegetLayoutPrototypeByUuidAndCompanyId(String uuid, long companyId) Returns the layout prototype with the matching UUID and company.static List<LayoutPrototype>getLayoutPrototypes(int start, int end) Returns a range of all the layout prototypes.static intReturns the number of layout prototypes.static StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static LayoutPrototypeLocalServicestatic List<LayoutPrototype>search(long companyId, Boolean active, int start, int end, OrderByComparator<LayoutPrototype> orderByComparator) static intsearchCount(long companyId, Boolean active) static voidsetService(LayoutPrototypeLocalService service) static LayoutPrototypeupdateLayoutPrototype(long layoutPrototypeId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, ServiceContext serviceContext) static LayoutPrototypeupdateLayoutPrototype(LayoutPrototype layoutPrototype) Updates the layout prototype in the database or adds it if it does not yet exist.
-
Constructor Details
-
LayoutPrototypeLocalServiceUtil
public LayoutPrototypeLocalServiceUtil()
-
-
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
public static 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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteLayoutPrototype
public static 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
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
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
public static <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
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
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
-
fetchLayoutPrototype
-
fetchLayoutPrototypeByUuidAndCompanyId
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
-
getActionableDynamicQuery
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
-
getLayoutPrototype
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
public static LayoutPrototype getLayoutPrototype(long companyId, String name) throws PortalException - Throws:
PortalException
-
getLayoutPrototype
public static LayoutPrototype getLayoutPrototype(long companyId, String name, Locale locale) throws PortalException - Throws:
PortalException
-
getLayoutPrototypeByUuidAndCompanyId
public static 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
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
public static int getLayoutPrototypesCount()Returns the number of layout prototypes.- Returns:
- the number of layout prototypes
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
search
public static 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
public static LayoutPrototype updateLayoutPrototype(long layoutPrototypeId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> descriptionMap, boolean active, ServiceContext serviceContext) - Throws:
PortalException
-
getService
-
setService
-