com.liferay.object.service.ObjectFolderLocalService Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2023 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.ObjectFolder;
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.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
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.List;
import java.util.Locale;
import java.util.Map;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for ObjectFolder. 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 ObjectFolderLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface ObjectFolderLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.object.service.impl.ObjectFolderLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the object folder local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link ObjectFolderLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the object folder to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectFolderLocalServiceImpl 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 objectFolder the object folder
* @return the object folder that was added
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectFolder addObjectFolder(ObjectFolder objectFolder);
@Indexable(type = IndexableType.REINDEX)
public ObjectFolder addObjectFolder(
String externalReferenceCode, long userId,
Map labelMap, String name)
throws PortalException;
/**
* Creates a new object folder with the primary key. Does not add the object folder to the database.
*
* @param objectFolderId the primary key for the new object folder
* @return the new object folder
*/
@Transactional(enabled = false)
public ObjectFolder createObjectFolder(long objectFolderId);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
public void deleteCompanyObjectFolders(long companyId)
throws PortalException;
/**
* Deletes the object folder with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectFolderLocalServiceImpl 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 objectFolderId the primary key of the object folder
* @return the object folder that was removed
* @throws PortalException if a object folder with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public ObjectFolder deleteObjectFolder(long objectFolderId)
throws PortalException;
/**
* Deletes the object folder from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectFolderLocalServiceImpl 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 objectFolder the object folder
* @return the object folder that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@SystemEvent(type = SystemEventConstants.TYPE_DELETE)
public ObjectFolder deleteObjectFolder(ObjectFolder objectFolder)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
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.ObjectFolderModelImpl.
*
*
* @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.ObjectFolderModelImpl.
*
*
* @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 ObjectFolder fetchDefaultObjectFolder(long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectFolder fetchObjectFolder(long objectFolderId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectFolder fetchObjectFolder(long companyId, String name);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectFolder fetchObjectFolderByExternalReferenceCode(
String externalReferenceCode, long companyId);
/**
* Returns the object folder with the matching UUID and company.
*
* @param uuid the object folder's UUID
* @param companyId the primary key of the company
* @return the matching object folder, or null if a matching object folder could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectFolder fetchObjectFolderByUuidAndCompanyId(
String uuid, long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectFolder getDefaultObjectFolder(long companyId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the object folder with the primary key.
*
* @param objectFolderId the primary key of the object folder
* @return the object folder
* @throws PortalException if a object folder with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectFolder getObjectFolder(long objectFolderId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectFolder getObjectFolder(long companyId, String name)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectFolder getObjectFolderByExternalReferenceCode(
String externalReferenceCode, long companyId)
throws PortalException;
/**
* Returns the object folder with the matching UUID and company.
*
* @param uuid the object folder's UUID
* @param companyId the primary key of the company
* @return the matching object folder
* @throws PortalException if a matching object folder could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectFolder getObjectFolderByUuidAndCompanyId(
String uuid, long companyId)
throws PortalException;
/**
* Returns a range of all the object folders.
*
*
* 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.ObjectFolderModelImpl.
*
*
* @param start the lower bound of the range of object folders
* @param end the upper bound of the range of object folders (not inclusive)
* @return the range of object folders
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getObjectFolders(int start, int end);
/**
* Returns the number of object folders.
*
* @return the number of object folders
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectFoldersCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getObjectFoldersCount(long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ObjectFolder getOrAddDefaultObjectFolder(long companyId)
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;
/**
* Updates the object folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect ObjectFolderLocalServiceImpl 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 objectFolder the object folder
* @return the object folder that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public ObjectFolder updateObjectFolder(ObjectFolder objectFolder);
@Indexable(type = IndexableType.REINDEX)
public ObjectFolder updateObjectFolder(
String externalReferenceCode, long objectFolderId,
Map labelMap)
throws PortalException;
}