com.liferay.portal.kernel.service.WebDAVPropsLocalService Maven / Gradle / Ivy
Show all versions of com.liferay.portal.kernel Show documentation
/**
* 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.portal.kernel.service;
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.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.WebDAVProps;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.spring.osgi.OSGiBeanProperties;
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 org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for WebDAVProps. 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 Brian Wing Shun Chan
* @see WebDAVPropsLocalServiceUtil
* @generated
*/
@OSGiBeanProperties(
property = {"model.class.name=com.liferay.portal.kernel.model.WebDAVProps"}
)
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface WebDAVPropsLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.portal.service.impl.WebDAVPropsLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the web dav props local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link WebDAVPropsLocalServiceUtil} if injection and service tracking are not available.
*/
/**
* Adds the web dav props to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect WebDAVPropsLocalServiceImpl 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 webDAVProps the web dav props
* @return the web dav props that was added
*/
@Indexable(type = IndexableType.REINDEX)
public WebDAVProps addWebDAVProps(WebDAVProps webDAVProps);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Creates a new web dav props with the primary key. Does not add the web dav props to the database.
*
* @param webDavPropsId the primary key for the new web dav props
* @return the new web dav props
*/
@Transactional(enabled = false)
public WebDAVProps createWebDAVProps(long webDavPropsId);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
/**
* Deletes the web dav props with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect WebDAVPropsLocalServiceImpl 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 webDavPropsId the primary key of the web dav props
* @return the web dav props that was removed
* @throws PortalException if a web dav props with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public WebDAVProps deleteWebDAVProps(long webDavPropsId)
throws PortalException;
public void deleteWebDAVProps(String className, long classPK);
/**
* Deletes the web dav props from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect WebDAVPropsLocalServiceImpl 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 webDAVProps the web dav props
* @return the web dav props that was removed
*/
@Indexable(type = IndexableType.DELETE)
public WebDAVProps deleteWebDAVProps(WebDAVProps webDAVProps);
@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.portal.model.impl.WebDAVPropsModelImpl.
*
*
* @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.portal.model.impl.WebDAVPropsModelImpl.
*
*
* @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 WebDAVProps fetchWebDAVProps(long webDavPropsId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* 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;
/**
* Returns the web dav props with the primary key.
*
* @param webDavPropsId the primary key of the web dav props
* @return the web dav props
* @throws PortalException if a web dav props with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public WebDAVProps getWebDAVProps(long webDavPropsId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public WebDAVProps getWebDAVProps(
long companyId, String className, long classPK);
/**
* Returns a range of all the web dav propses.
*
*
* 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.portal.model.impl.WebDAVPropsModelImpl.
*
*
* @param start the lower bound of the range of web dav propses
* @param end the upper bound of the range of web dav propses (not inclusive)
* @return the range of web dav propses
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getWebDAVPropses(int start, int end);
/**
* Returns the number of web dav propses.
*
* @return the number of web dav propses
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getWebDAVPropsesCount();
public void storeWebDAVProps(WebDAVProps webDAVProps)
throws PortalException;
/**
* Updates the web dav props in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect WebDAVPropsLocalServiceImpl 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 webDAVProps the web dav props
* @return the web dav props that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public WebDAVProps updateWebDAVProps(WebDAVProps webDAVProps);
}