com.liferay.object.service.ObjectRelationshipLocalServiceUtil 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.ObjectRelationship;
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 ObjectRelationship. This utility wraps
* com.liferay.object.service.impl.ObjectRelationshipLocalServiceImpl 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 ObjectRelationshipLocalService
* @generated
*/
public class ObjectRelationshipLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to com.liferay.object.service.impl.ObjectRelationshipLocalServiceImpl and rerun ServiceBuilder to regenerate this class.
*/
/**
* Adds the object relationship to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectRelationshipLocalServiceImpl 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 objectRelationship the object relationship
* @return the object relationship that was added
*/
public static ObjectRelationship addObjectRelationship(
ObjectRelationship objectRelationship) {
return getService().addObjectRelationship(objectRelationship);
}
public static ObjectRelationship addObjectRelationship(
String externalReferenceCode, long userId, long objectDefinitionId1,
long objectDefinitionId2, long parameterObjectFieldId,
String deletionType, Map labelMap,
String name, boolean system, String type,
com.liferay.object.model.ObjectField objectField)
throws PortalException {
return getService().addObjectRelationship(
externalReferenceCode, userId, objectDefinitionId1,
objectDefinitionId2, parameterObjectFieldId, deletionType, labelMap,
name, system, type, objectField);
}
public static ObjectRelationship addObjectRelationship(
String externalReferenceCode, long userId, long objectDefinitionId1,
long objectDefinitionId2,
com.liferay.object.model.ObjectField objectField)
throws PortalException {
return getService().addObjectRelationship(
externalReferenceCode, userId, objectDefinitionId1,
objectDefinitionId2, objectField);
}
public static void addObjectRelationshipMappingTableValues(
long userId, long objectRelationshipId, long primaryKey1,
long primaryKey2,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws PortalException {
getService().addObjectRelationshipMappingTableValues(
userId, objectRelationshipId, primaryKey1, primaryKey2,
serviceContext);
}
public static ObjectRelationship createManyToManyObjectRelationshipTable(
long userId, ObjectRelationship objectRelationship)
throws PortalException {
return getService().createManyToManyObjectRelationshipTable(
userId, objectRelationship);
}
/**
* Creates a new object relationship with the primary key. Does not add the object relationship to the database.
*
* @param objectRelationshipId the primary key for the new object relationship
* @return the new object relationship
*/
public static ObjectRelationship createObjectRelationship(
long objectRelationshipId) {
return getService().createObjectRelationship(objectRelationshipId);
}
/**
* @throws PortalException
*/
public static PersistedModel createPersistedModel(
Serializable primaryKeyObj)
throws PortalException {
return getService().createPersistedModel(primaryKeyObj);
}
/**
* Deletes the object relationship with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectRelationshipLocalServiceImpl 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 objectRelationshipId the primary key of the object relationship
* @return the object relationship that was removed
* @throws PortalException if a object relationship with the primary key could not be found
*/
public static ObjectRelationship deleteObjectRelationship(
long objectRelationshipId)
throws PortalException {
return getService().deleteObjectRelationship(objectRelationshipId);
}
/**
* Deletes the object relationship from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectRelationshipLocalServiceImpl 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 objectRelationship the object relationship
* @return the object relationship that was removed
* @throws PortalException
*/
public static ObjectRelationship deleteObjectRelationship(
ObjectRelationship objectRelationship)
throws PortalException {
return getService().deleteObjectRelationship(objectRelationship);
}
public static void deleteObjectRelationshipMappingTableValues(
long objectRelationshipId, long primaryKey1)
throws PortalException {
getService().deleteObjectRelationshipMappingTableValues(
objectRelationshipId, primaryKey1);
}
public static void deleteObjectRelationshipMappingTableValues(
long objectRelationshipId, long primaryKey1, long primaryKey2)
throws PortalException {
getService().deleteObjectRelationshipMappingTableValues(
objectRelationshipId, primaryKey1, primaryKey2);
}
public static void deleteObjectRelationships(long objectDefinitionId1)
throws PortalException {
getService().deleteObjectRelationships(objectDefinitionId1);
}
public static void deleteObjectRelationships(
long objectDefinitionId1, boolean reverse)
throws PortalException {
getService().deleteObjectRelationships(objectDefinitionId1, reverse);
}
/**
* @throws PortalException
*/
public static PersistedModel deletePersistedModel(
PersistedModel persistedModel)
throws PortalException {
return getService().deletePersistedModel(persistedModel);
}
public static void disableEdge(long objectDefinitionId2)
throws PortalException {
getService().disableEdge(objectDefinitionId2);
}
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.ObjectRelationshipModelImpl.
*
*
* @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.ObjectRelationshipModelImpl.
*
*
* @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 ObjectRelationship enableEdge(
long objectRelationshipId, boolean edge)
throws PortalException {
return getService().enableEdge(objectRelationshipId, edge);
}
public static ObjectRelationship fetchObjectRelationship(
long objectRelationshipId) {
return getService().fetchObjectRelationship(objectRelationshipId);
}
public static ObjectRelationship
fetchObjectRelationshipByExternalReferenceCode(
String externalReferenceCode, long objectDefinitionId1) {
return getService().fetchObjectRelationshipByExternalReferenceCode(
externalReferenceCode, objectDefinitionId1);
}
public static ObjectRelationship
fetchObjectRelationshipByExternalReferenceCode(
String externalReferenceCode, long companyId,
long objectDefinitionId1) {
return getService().fetchObjectRelationshipByExternalReferenceCode(
externalReferenceCode, companyId, objectDefinitionId1);
}
public static ObjectRelationship
fetchObjectRelationshipByObjectDefinitionId(
long objectDefinitionId, String name) {
return getService().fetchObjectRelationshipByObjectDefinitionId(
objectDefinitionId, name);
}
public static ObjectRelationship
fetchObjectRelationshipByObjectDefinitionId1(
long objectDefinitionId1, String name) {
return getService().fetchObjectRelationshipByObjectDefinitionId1(
objectDefinitionId1, name);
}
public static ObjectRelationship fetchObjectRelationshipByObjectFieldId2(
long objectFieldId2) {
return getService().fetchObjectRelationshipByObjectFieldId2(
objectFieldId2);
}
/**
* Returns the object relationship with the matching UUID and company.
*
* @param uuid the object relationship's UUID
* @param companyId the primary key of the company
* @return the matching object relationship, or null if a matching object relationship could not be found
*/
public static ObjectRelationship fetchObjectRelationshipByUuidAndCompanyId(
String uuid, long companyId) {
return getService().fetchObjectRelationshipByUuidAndCompanyId(
uuid, companyId);
}
public static ObjectRelationship fetchReverseObjectRelationship(
ObjectRelationship objectRelationship, boolean reverse) {
return getService().fetchReverseObjectRelationship(
objectRelationship, reverse);
}
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
getActionableDynamicQuery() {
return getService().getActionableDynamicQuery();
}
public static List getAllObjectRelationships(
long objectDefinitionId) {
return getService().getAllObjectRelationships(objectDefinitionId);
}
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 relationship with the primary key.
*
* @param objectRelationshipId the primary key of the object relationship
* @return the object relationship
* @throws PortalException if a object relationship with the primary key could not be found
*/
public static ObjectRelationship getObjectRelationship(
long objectRelationshipId)
throws PortalException {
return getService().getObjectRelationship(objectRelationshipId);
}
public static ObjectRelationship getObjectRelationship(
long objectDefinitionId1, String name)
throws PortalException {
return getService().getObjectRelationship(objectDefinitionId1, name);
}
public static ObjectRelationship
getObjectRelationshipByExternalReferenceCode(
String externalReferenceCode, long companyId,
long objectDefinitionId1)
throws PortalException {
return getService().getObjectRelationshipByExternalReferenceCode(
externalReferenceCode, companyId, objectDefinitionId1);
}
public static ObjectRelationship getObjectRelationshipByObjectDefinitionId(
long objectDefinitionId, String name)
throws PortalException {
return getService().getObjectRelationshipByObjectDefinitionId(
objectDefinitionId, name);
}
/**
* Returns the object relationship with the matching UUID and company.
*
* @param uuid the object relationship's UUID
* @param companyId the primary key of the company
* @return the matching object relationship
* @throws PortalException if a matching object relationship could not be found
*/
public static ObjectRelationship getObjectRelationshipByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException {
return getService().getObjectRelationshipByUuidAndCompanyId(
uuid, companyId);
}
/**
* Returns a range of all the object relationships.
*
*
* 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.ObjectRelationshipModelImpl.
*
*
* @param start the lower bound of the range of object relationships
* @param end the upper bound of the range of object relationships (not inclusive)
* @return the range of object relationships
*/
public static List getObjectRelationships(
int start, int end) {
return getService().getObjectRelationships(start, end);
}
public static List getObjectRelationships(
long objectDefinitionId1) {
return getService().getObjectRelationships(objectDefinitionId1);
}
public static List getObjectRelationships(
long objectDefinitionId1, boolean edge) {
return getService().getObjectRelationships(objectDefinitionId1, edge);
}
public static List getObjectRelationships(
long objectDefinitionId1, int start, int end) {
return getService().getObjectRelationships(
objectDefinitionId1, start, end);
}
public static List getObjectRelationships(
long objectDefinitionId1, long objectDefinition2, String type) {
return getService().getObjectRelationships(
objectDefinitionId1, objectDefinition2, type);
}
public static List getObjectRelationships(
long objectDefinitionId, String type) {
return getService().getObjectRelationships(objectDefinitionId, type);
}
public static List getObjectRelationships(
long objectDefinitionId1, String deletionType, boolean reverse) {
return getService().getObjectRelationships(
objectDefinitionId1, deletionType, reverse);
}
public static List
getObjectRelationshipsByObjectDefinitionId2(long objectDefinitionId2) {
return getService().getObjectRelationshipsByObjectDefinitionId2(
objectDefinitionId2);
}
/**
* Returns the number of object relationships.
*
* @return the number of object relationships
*/
public static int getObjectRelationshipsCount() {
return getService().getObjectRelationshipsCount();
}
/**
* 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
registerObjectRelationshipsRelatedInfoCollectionProviders(
com.liferay.object.model.ObjectDefinition objectDefinition1,
ObjectDefinitionLocalService objectDefinitionLocalService) {
getService().registerObjectRelationshipsRelatedInfoCollectionProviders(
objectDefinition1, objectDefinitionLocalService);
}
/**
* Updates the object relationship in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectRelationshipLocalServiceImpl 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 objectRelationship the object relationship
* @return the object relationship that was updated
*/
public static ObjectRelationship updateObjectRelationship(
ObjectRelationship objectRelationship) {
return getService().updateObjectRelationship(objectRelationship);
}
public static ObjectRelationship updateObjectRelationship(
String externalReferenceCode, long objectRelationshipId,
long parameterObjectFieldId, String deletionType, boolean edge,
Map labelMap,
com.liferay.object.model.ObjectField objectField)
throws PortalException {
return getService().updateObjectRelationship(
externalReferenceCode, objectRelationshipId, parameterObjectFieldId,
deletionType, edge, labelMap, objectField);
}
public static ObjectRelationshipLocalService getService() {
return _serviceSnapshot.get();
}
private static final Snapshot
_serviceSnapshot = new Snapshot<>(
ObjectRelationshipLocalServiceUtil.class,
ObjectRelationshipLocalService.class);
}