com.liferay.object.service.ObjectEntryLocalService 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.exportimport.kernel.lar.PortletDataContext;
import com.liferay.object.model.ObjectDefinition;
import com.liferay.object.model.ObjectEntry;
import com.liferay.petra.sql.dsl.expression.Predicate;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Projection;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.model.SystemEventConstants;
import com.liferay.portal.kernel.search.BaseModelSearchResult;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.search.Sort;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.systemevent.SystemEvent;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import java.io.Serializable;
import java.util.Date;
import java.util.List;
import java.util.Map;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for ObjectEntry. 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 ObjectEntryLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface ObjectEntryLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.object.service.impl.ObjectEntryLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the object entry local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link ObjectEntryLocalServiceUtil} if injection and service tracking are not available.
*/
public ObjectEntry addObjectEntry(
long userId, long groupId, long objectDefinitionId,
Map values, ServiceContext serviceContext)
throws PortalException;
/**
* Adds the object entry to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectEntryLocalServiceImpl 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 objectEntry the object entry
* @return the object entry that was added
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectEntry addObjectEntry(ObjectEntry objectEntry);
public ObjectEntry addObjectEntry(
String externalReferenceCode, long userId,
ObjectDefinition objectDefinition)
throws PortalException;
public void addOrUpdateExtensionDynamicObjectDefinitionTableValues(
long userId, ObjectDefinition objectDefinition, long primaryKey,
Map values, ServiceContext serviceContext)
throws PortalException;
public ObjectEntry addOrUpdateObjectEntry(
String externalReferenceCode, long userId, long groupId,
long objectDefinitionId, Map values,
ServiceContext serviceContext)
throws PortalException;
/**
* Creates a new object entry with the primary key. Does not add the object entry to the database.
*
* @param objectEntryId the primary key for the new object entry
* @return the new object entry
*/
@Transactional(enabled = false)
public ObjectEntry createObjectEntry(long objectEntryId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
public void deleteExtensionDynamicObjectDefinitionTableValues(
ObjectDefinition objectDefinition, long primaryKey)
throws PortalException;
/**
* Deletes the object entry with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectEntryLocalServiceImpl 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 objectEntryId the primary key of the object entry
* @return the object entry that was removed
* @throws PortalException if a object entry with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public ObjectEntry deleteObjectEntry(long objectEntryId)
throws PortalException;
/**
* Deletes the object entry from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectEntryLocalServiceImpl 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 objectEntry the object entry
* @return the object entry that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@SystemEvent(type = SystemEventConstants.TYPE_DELETE)
public ObjectEntry deleteObjectEntry(ObjectEntry objectEntry)
throws PortalException;
public ObjectEntry deleteObjectEntry(
String externalReferenceCode, long companyId, long groupId)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
public void deleteRelatedObjectEntries(
long groupId, long objectDefinitionId, long primaryKey)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public T dslQuery(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int dslQueryCount(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(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.ObjectEntryModelImpl.
*
*
* @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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int 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.ObjectEntryModelImpl.
*
*
* @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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectEntry fetchManyToOneObjectEntry(
long groupId, long objectRelationshipId, long primaryKey)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectEntry fetchObjectEntry(long objectEntryId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectEntry fetchObjectEntry(
String externalReferenceCode, long objectDefinitionId);
/**
* Returns the object entry matching the UUID and group.
*
* @param uuid the object entry's UUID
* @param groupId the primary key of the group
* @return the matching object entry, or null if a matching object entry could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectEntry fetchObjectEntryByUuidAndGroupId(
String uuid, long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Map getAggregationCounts(
long groupId, long objectDefinitionId, String aggregationTerm,
Predicate predicate, int start, int end)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Map
getExtensionDynamicObjectDefinitionTableValues(
ObjectDefinition objectDefinition, long primaryKey)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getManyToManyObjectEntries(
long groupId, long objectRelationshipId, long primaryKey,
boolean related, boolean reverse, String search, int start, int end)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getManyToManyObjectEntriesCount(
long groupId, long objectRelationshipId, long primaryKey,
boolean related, boolean reverse, String search)
throws PortalException;
/**
* Returns a range of all the object entries.
*
*
* 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.ObjectEntryModelImpl.
*
*
* @param start the lower bound of the range of object entries
* @param end the upper bound of the range of object entries (not inclusive)
* @return the range of object entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectEntries(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectEntries(
long groupId, long objectDefinitionId, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectEntries(
long groupId, long objectDefinitionId, int status, int start, int end);
/**
* Returns all the object entries matching the UUID and company.
*
* @param uuid the UUID of the object entries
* @param companyId the primary key of the company
* @return the matching object entries, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectEntriesByUuidAndCompanyId(
String uuid, long companyId);
/**
* Returns a range of object entries matching the UUID and company.
*
* @param uuid the UUID of the object entries
* @param companyId the primary key of the company
* @param start the lower bound of the range of object entries
* @param end the upper bound of the range of object entries (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching object entries, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectEntriesByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of object entries.
*
* @return the number of object entries
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectEntriesCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectEntriesCount(long objectDefinitionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long getObjectEntriesCount(
long userId, Date createDate, long objectDefinitionId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectEntriesCount(long groupId, long objectDefinitionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long getObjectEntriesCount(
long groupId, ObjectDefinition objectDefinition,
Predicate predicate)
throws PortalException;
/**
* Returns the object entry with the primary key.
*
* @param objectEntryId the primary key of the object entry
* @return the object entry
* @throws PortalException if a object entry with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectEntry getObjectEntry(long objectEntryId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectEntry getObjectEntry(
String externalReferenceCode, long objectDefinitionId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectEntry getObjectEntry(
String externalReferenceCode, long companyId, long groupId)
throws PortalException;
/**
* Returns the object entry matching the UUID and group.
*
* @param uuid the object entry's UUID
* @param groupId the primary key of the group
* @return the matching object entry
* @throws PortalException if a matching object entry could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectEntry getObjectEntryByUuidAndGroupId(String uuid, long groupId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getOneToManyObjectEntries(
long groupId, long objectRelationshipId, long primaryKey,
boolean related, String search, int start, int end)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getOneToManyObjectEntriesCount(
long groupId, long objectRelationshipId, long primaryKey,
boolean related, String search)
throws PortalException;
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
/**
* @throws PortalException
*/
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Map getSystemModelAttributes(
ObjectDefinition objectDefinition, long primaryKey)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Map getSystemValues(ObjectEntry objectEntry)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public String getTitleValue(long objectDefinitionId, long primaryKey)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Map getValues(long objectEntryId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Map getValues(ObjectEntry objectEntry)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List> getValuesList(
long groupId, long companyId, long userId, long objectDefinitionId,
String[] selectedObjectFieldNames, Predicate predicate,
String search, int start, int end, Sort[] sorts)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getValuesListCount(
long groupId, long companyId, long userId, long objectDefinitionId,
Predicate predicate, String search)
throws PortalException;
public void insertIntoOrUpdateExtensionTable(
long userId, long objectDefinitionId, long primaryKey,
Map values)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public BaseModelSearchResult searchObjectEntries(
long groupId, long objectDefinitionId, String keywords, int cur,
int delta)
throws PortalException;
public void updateAsset(
long userId, ObjectEntry objectEntry, long[] assetCategoryIds,
String[] assetTagNames, long[] assetLinkEntryIds, Double priority)
throws PortalException;
public ObjectEntry updateObjectEntry(
long userId, long objectEntryId, Map values,
ServiceContext serviceContext)
throws PortalException;
/**
* Updates the object entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectEntryLocalServiceImpl 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 objectEntry the object entry
* @return the object entry that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectEntry updateObjectEntry(ObjectEntry objectEntry);
public ObjectEntry updateStatus(
long userId, long objectEntryId, int status,
ServiceContext serviceContext)
throws PortalException;
public ObjectEntry updateStatus(
long userId, ObjectEntry objectEntry, int status,
ServiceContext serviceContext)
throws PortalException;
}