com.liferay.object.service.ObjectRelationshipService 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.ObjectField;
import com.liferay.object.model.ObjectRelationship;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.jsonwebservice.JSONWebService;
import com.liferay.portal.kernel.security.access.control.AccessControlled;
import com.liferay.portal.kernel.service.BaseService;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the remote service interface for ObjectRelationship. Methods of this
* service are expected to have security checks based on the propagated JAAS
* credentials because this service can be accessed remotely.
*
* @author Marco Leo
* @see ObjectRelationshipServiceUtil
* @generated
*/
@AccessControlled
@JSONWebService
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface ObjectRelationshipService extends BaseService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.object.service.impl.ObjectRelationshipServiceImpl
and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the object relationship remote service via injection or a org.osgi.util.tracker.ServiceTracker
. Use {@link ObjectRelationshipServiceUtil} if injection and service tracking are not available.
*/
public ObjectRelationship addObjectRelationship(
String externalReferenceCode, long objectDefinitionId1,
long objectDefinitionId2, long parameterObjectFieldId,
String deletionType, Map labelMap, String name,
boolean system, String type, ObjectField objectField)
throws PortalException;
public void addObjectRelationshipMappingTableValues(
long objectRelationshipId, long primaryKey1, long primaryKey2,
ServiceContext serviceContext)
throws PortalException;
public ObjectRelationship deleteObjectRelationship(
long objectRelationshipId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectRelationship fetchObjectRelationshipByExternalReferenceCode(
String externalReferenceCode, long companyId,
long objectDefinitionId1)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectRelationship getObjectRelationship(long objectRelationshipId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectRelationship getObjectRelationship(
long objectDefinitionId1, String name)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectRelationships(
long objectDefinitionId1, int start, int end)
throws PortalException;
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
public ObjectRelationship updateObjectRelationship(
String externalReferenceCode, long objectRelationshipId,
long parameterObjectFieldId, String deletionType, boolean edge,
Map labelMap, ObjectField objectField)
throws PortalException;
}