Class LayoutSetPrototypeLocalServiceUtil
com.liferay.portal.service.impl.LayoutSetPrototypeLocalServiceImpl 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 LayoutSetPrototypeaddLayoutSetPrototype(long userId, long companyId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, boolean layoutsUpdateable, boolean readyForPropagation, ServiceContext serviceContext) static LayoutSetPrototypeaddLayoutSetPrototype(long userId, long companyId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) static LayoutSetPrototypeaddLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype) Adds the layout set prototype to the database.static LayoutSetPrototypecreateLayoutSetPrototype(long layoutSetPrototypeId) Creates a new layout set prototype with the primary key.static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static LayoutSetPrototypedeleteLayoutSetPrototype(long layoutSetPrototypeId) Deletes the layout set prototype with the primary key from the database.static LayoutSetPrototypedeleteLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype) Deletes the layout set prototype from the database.static voidstatic voiddeleteNondefaultLayoutSetPrototypes(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 LayoutSetPrototypefetchLayoutSetPrototype(long layoutSetPrototypeId) static LayoutSetPrototypefetchLayoutSetPrototypeByUuidAndCompanyId(String uuid, long companyId) Returns the layout set prototype with the matching UUID and company.static ActionableDynamicQuerystatic ExportActionableDynamicQuerygetExportActionableDynamicQuery(PortletDataContext portletDataContext) static LayoutSetPrototypegetLayoutSetPrototype(long layoutSetPrototypeId) Returns the layout set prototype with the primary key.static LayoutSetPrototypegetLayoutSetPrototypeByUuidAndCompanyId(String uuid, long companyId) Returns the layout set prototype with the matching UUID and company.static List<LayoutSetPrototype>getLayoutSetPrototypes(int start, int end) Returns a range of all the layout set prototypes.static List<LayoutSetPrototype>getLayoutSetPrototypes(long companyId) static intReturns the number of layout set prototypes.static StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static List<LayoutSetPrototype>search(long companyId, Boolean active, int start, int end, OrderByComparator<LayoutSetPrototype> orderByComparator) static intsearchCount(long companyId, Boolean active) static voidsetService(LayoutSetPrototypeLocalService service) static LayoutSetPrototypeupdateLayoutSetPrototype(long layoutSetPrototypeId, String settings) static LayoutSetPrototypeupdateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, boolean layoutsUpdateable, boolean readyForPropagation, ServiceContext serviceContext) static LayoutSetPrototypeupdateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) static LayoutSetPrototypeupdateLayoutSetPrototype(LayoutSetPrototype layoutSetPrototype) Updates the layout set prototype in the database or adds it if it does not yet exist.
-
Constructor Details
-
LayoutSetPrototypeLocalServiceUtil
public LayoutSetPrototypeLocalServiceUtil()
-
-
Method Details
-
addLayoutSetPrototype
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
public static 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
public static LayoutSetPrototype addLayoutSetPrototype(long userId, long companyId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) - Throws:
PortalException
-
createLayoutSetPrototype
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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteLayoutSetPrototype
public static 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
public static 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
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.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
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.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
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
-
fetchLayoutSetPrototype
-
fetchLayoutSetPrototypeByUuidAndCompanyId
public static 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
nullif a matching layout set prototype could not be found
-
getActionableDynamicQuery
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
-
getLayoutSetPrototype
public static 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
public static 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
Returns a range of all the layout set 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.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
-
getLayoutSetPrototypesCount
public static int getLayoutSetPrototypesCount()Returns the number of layout set prototypes.- Returns:
- the number of layout set prototypes
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
search
public static List<LayoutSetPrototype> search(long companyId, Boolean active, int start, int end, OrderByComparator<LayoutSetPrototype> orderByComparator) -
searchCount
-
updateLayoutSetPrototype
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
public static LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> descriptionMap, boolean active, boolean layoutsUpdateable, boolean readyForPropagation, ServiceContext serviceContext) - Throws:
PortalException
-
updateLayoutSetPrototype
public static LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> descriptionMap, boolean active, boolean layoutsUpdateable, ServiceContext serviceContext) - Throws:
PortalException
-
updateLayoutSetPrototype
public static LayoutSetPrototype updateLayoutSetPrototype(long layoutSetPrototypeId, String settings) throws PortalException - Throws:
PortalException
-
getService
-
setService
-