com.liferay.object.service.ObjectViewLocalServiceUtil Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.object.service;
import com.liferay.object.model.ObjectView;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.module.service.Snapshot;
import com.liferay.portal.kernel.util.OrderByComparator;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
/**
* Provides the local service utility for ObjectView. This utility wraps
* com.liferay.object.service.impl.ObjectViewLocalServiceImpl 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 Marco Leo
* @see ObjectViewLocalService
* @generated
*/
public class ObjectViewLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to com.liferay.object.service.impl.ObjectViewLocalServiceImpl and rerun ServiceBuilder to regenerate this class.
*/
public static ObjectView addObjectView(
long userId, long objectDefinitionId, boolean defaultObjectView,
Map nameMap,
List objectViewColumns,
List
objectViewFilterColumns,
List
objectViewSortColumns)
throws PortalException {
return getService().addObjectView(
userId, objectDefinitionId, defaultObjectView, nameMap,
objectViewColumns, objectViewFilterColumns, objectViewSortColumns);
}
/**
* Adds the object view to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectViewLocalServiceImpl 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.
*
*
* @param objectView the object view
* @return the object view that was added
*/
public static ObjectView addObjectView(ObjectView objectView) {
return getService().addObjectView(objectView);
}
/**
* Creates a new object view with the primary key. Does not add the object view to the database.
*
* @param objectViewId the primary key for the new object view
* @return the new object view
*/
public static ObjectView createObjectView(long objectViewId) {
return getService().createObjectView(objectViewId);
}
/**
* @throws PortalException
*/
public static PersistedModel createPersistedModel(
Serializable primaryKeyObj)
throws PortalException {
return getService().createPersistedModel(primaryKeyObj);
}
/**
* Deletes the object view with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectViewLocalServiceImpl 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.
*
*
* @param objectViewId the primary key of the object view
* @return the object view that was removed
* @throws PortalException if a object view with the primary key could not be found
*/
public static ObjectView deleteObjectView(long objectViewId)
throws PortalException {
return getService().deleteObjectView(objectViewId);
}
/**
* Deletes the object view from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectViewLocalServiceImpl 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.
*
*
* @param objectView the object view
* @return the object view that was removed
*/
public static ObjectView deleteObjectView(ObjectView objectView) {
return getService().deleteObjectView(objectView);
}
public static void deleteObjectViews(long objectDefinitionId)
throws PortalException {
getService().deleteObjectViews(objectDefinitionId);
}
/**
* @throws PortalException
*/
public static PersistedModel deletePersistedModel(
PersistedModel persistedModel)
throws PortalException {
return getService().deletePersistedModel(persistedModel);
}
public static T dslQuery(DSLQuery dslQuery) {
return getService().dslQuery(dslQuery);
}
public static int dslQueryCount(DSLQuery dslQuery) {
return getService().dslQueryCount(dslQuery);
}
public static DynamicQuery dynamicQuery() {
return getService().dynamicQuery();
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
public static List dynamicQuery(DynamicQuery dynamicQuery) {
return getService().dynamicQuery(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 - 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectViewModelImpl.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
*/
public static List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end) {
return getService().dynamicQuery(dynamicQuery, start, end);
}
/**
* 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectViewModelImpl.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
*/
public static List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator) {
return getService().dynamicQuery(
dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(DynamicQuery dynamicQuery) {
return getService().dynamicQueryCount(dynamicQuery);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(
DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection) {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static ObjectView fetchDefaultObjectView(long objectDefinitionId) {
return getService().fetchDefaultObjectView(objectDefinitionId);
}
public static ObjectView fetchObjectView(long objectViewId) {
return getService().fetchObjectView(objectViewId);
}
/**
* Returns the object view with the matching UUID and company.
*
* @param uuid the object view's UUID
* @param companyId the primary key of the company
* @return the matching object view, or null if a matching object view could not be found
*/
public static ObjectView fetchObjectViewByUuidAndCompanyId(
String uuid, long companyId) {
return getService().fetchObjectViewByUuidAndCompanyId(uuid, companyId);
}
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
getActionableDynamicQuery() {
return getService().getActionableDynamicQuery();
}
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery(
com.liferay.exportimport.kernel.lar.PortletDataContext
portletDataContext) {
return getService().getExportActionableDynamicQuery(portletDataContext);
}
public static
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
return getService().getIndexableActionableDynamicQuery();
}
/**
* Returns the object view with the primary key.
*
* @param objectViewId the primary key of the object view
* @return the object view
* @throws PortalException if a object view with the primary key could not be found
*/
public static ObjectView getObjectView(long objectViewId)
throws PortalException {
return getService().getObjectView(objectViewId);
}
/**
* Returns the object view with the matching UUID and company.
*
* @param uuid the object view's UUID
* @param companyId the primary key of the company
* @return the matching object view
* @throws PortalException if a matching object view could not be found
*/
public static ObjectView getObjectViewByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException {
return getService().getObjectViewByUuidAndCompanyId(uuid, companyId);
}
/**
* Returns a range of all the object views.
*
*
* 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectViewModelImpl.
*
*
* @param start the lower bound of the range of object views
* @param end the upper bound of the range of object views (not inclusive)
* @return the range of object views
*/
public static List getObjectViews(int start, int end) {
return getService().getObjectViews(start, end);
}
public static List getObjectViews(long objectDefinitionId) {
return getService().getObjectViews(objectDefinitionId);
}
/**
* Returns the number of object views.
*
* @return the number of object views
*/
public static int getObjectViewsCount() {
return getService().getObjectViewsCount();
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public static String getOSGiServiceIdentifier() {
return getService().getOSGiServiceIdentifier();
}
/**
* @throws PortalException
*/
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return getService().getPersistedModel(primaryKeyObj);
}
public static void unassociateObjectField(
com.liferay.object.model.ObjectField objectField) {
getService().unassociateObjectField(objectField);
}
public static ObjectView updateObjectView(
long objectViewId, boolean defaultObjectView,
Map nameMap,
List objectViewColumns,
List
objectViewFilterColumns,
List
objectViewSortColumns)
throws PortalException {
return getService().updateObjectView(
objectViewId, defaultObjectView, nameMap, objectViewColumns,
objectViewFilterColumns, objectViewSortColumns);
}
/**
* Updates the object view in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectViewLocalServiceImpl 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.
*
*
* @param objectView the object view
* @return the object view that was updated
*/
public static ObjectView updateObjectView(ObjectView objectView) {
return getService().updateObjectView(objectView);
}
public static ObjectViewLocalService getService() {
return _serviceSnapshot.get();
}
private static final Snapshot _serviceSnapshot =
new Snapshot<>(
ObjectViewLocalServiceUtil.class, ObjectViewLocalService.class);
}