com.liferay.portlet.documentlibrary.service.DLContentLocalService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portlet.documentlibrary.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
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.service.BaseLocalService;
import com.liferay.portal.service.PersistedModelLocalService;
/**
* Provides the local service interface for DLContent. 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 DLContentLocalServiceUtil
* @see com.liferay.portlet.documentlibrary.service.base.DLContentLocalServiceBaseImpl
* @see com.liferay.portlet.documentlibrary.service.impl.DLContentLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface DLContentLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link DLContentLocalServiceUtil} to access the document library content local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLContentLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the document library content to the database. Also notifies the appropriate model listeners.
*
* @param dlContent the document library content
* @return the document library content that was added
* @throws SystemException if a system exception occurred
*/
public com.liferay.portlet.documentlibrary.model.DLContent addDLContent(
com.liferay.portlet.documentlibrary.model.DLContent dlContent)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Creates a new document library content with the primary key. Does not add the document library content to the database.
*
* @param contentId the primary key for the new document library content
* @return the new document library content
*/
public com.liferay.portlet.documentlibrary.model.DLContent createDLContent(
long contentId);
/**
* Deletes the document library content with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param contentId the primary key of the document library content
* @return the document library content that was removed
* @throws PortalException if a document library content with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portlet.documentlibrary.model.DLContent deleteDLContent(
long contentId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Deletes the document library content from the database. Also notifies the appropriate model listeners.
*
* @param dlContent the document library content
* @return the document library content that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portlet.documentlibrary.model.DLContent deleteDLContent(
com.liferay.portlet.documentlibrary.model.DLContent dlContent)
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* 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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.documentlibrary.model.impl.DLContentModelImpl}. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @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
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.SystemException;
/**
* 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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.documentlibrary.model.impl.DLContentModelImpl}. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @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
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portlet.documentlibrary.model.DLContent fetchDLContent(
long contentId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the document library content with the primary key.
*
* @param contentId the primary key of the document library content
* @return the document library content
* @throws PortalException if a document library content with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portlet.documentlibrary.model.DLContent getDLContent(
long contentId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the document library contents.
*
*
* 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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.documentlibrary.model.impl.DLContentModelImpl}. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param start the lower bound of the range of document library contents
* @param end the upper bound of the range of document library contents (not inclusive)
* @return the range of document library contents
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getDLContents(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of document library contents.
*
* @return the number of document library contents
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getDLContentsCount()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Updates the document library content in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param dlContent the document library content
* @return the document library content that was updated
* @throws SystemException if a system exception occurred
*/
public com.liferay.portlet.documentlibrary.model.DLContent updateDLContent(
com.liferay.portlet.documentlibrary.model.DLContent dlContent)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portlet.documentlibrary.model.DLContentDataBlobModel getDataBlobModel(
java.io.Serializable primaryKey)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public java.lang.String getBeanIdentifier();
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public void setBeanIdentifier(java.lang.String beanIdentifier);
public com.liferay.portlet.documentlibrary.model.DLContent addContent(
long companyId, long repositoryId, java.lang.String path,
java.lang.String version, byte[] bytes)
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portlet.documentlibrary.model.DLContent addContent(
long companyId, long repositoryId, java.lang.String path,
java.lang.String version, java.io.InputStream inputStream, long size)
throws com.liferay.portal.kernel.exception.SystemException;
public void deleteContent(long companyId, long repositoryId,
java.lang.String path, java.lang.String version)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void deleteContents(long companyId, long repositoryId,
java.lang.String path)
throws com.liferay.portal.kernel.exception.SystemException;
public void deleteContentsByDirectory(long companyId, long repositoryId,
java.lang.String dirName)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portlet.documentlibrary.model.DLContent getContent(
long companyId, long repositoryId, java.lang.String path)
throws com.liferay.portal.kernel.exception.SystemException,
com.liferay.portlet.documentlibrary.NoSuchContentException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portlet.documentlibrary.model.DLContent getContent(
long companyId, long repositoryId, java.lang.String path,
java.lang.String version)
throws com.liferay.portal.kernel.exception.SystemException,
com.liferay.portlet.documentlibrary.NoSuchContentException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getContents(
long companyId, long repositoryId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getContents(
long companyId, long repositoryId, java.lang.String path)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getContentsByDirectory(
long companyId, long repositoryId, java.lang.String dirName)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasContent(long companyId, long repositoryId,
java.lang.String path, java.lang.String version)
throws com.liferay.portal.kernel.exception.SystemException;
public void updateDLContent(long companyId, long oldRepositoryId,
long newRepositoryId, java.lang.String oldPath, java.lang.String newPath)
throws com.liferay.portal.kernel.exception.SystemException;
}