com.liferay.portlet.documentlibrary.service.DLFileVersionLocalServiceUtil Maven / Gradle / Ivy
/**
* 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.bean.PortalBeanLocatorUtil;
import com.liferay.portal.kernel.util.ReferenceRegistry;
/**
* Provides the local service utility for DLFileVersion. This utility wraps
* {@link com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl} and is the
* primary access point for service operations in application layer code running
* on the local server. 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 DLFileVersionLocalService
* @see com.liferay.portlet.documentlibrary.service.base.DLFileVersionLocalServiceBaseImpl
* @see com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl
* @generated
*/
@ProviderType
public class DLFileVersionLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
*/
/**
* Adds the document library file version to the database. Also notifies the appropriate model listeners.
*
* @param dlFileVersion the document library file version
* @return the document library file version that was added
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.documentlibrary.model.DLFileVersion addDLFileVersion(
com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().addDLFileVersion(dlFileVersion);
}
/**
* Creates a new document library file version with the primary key. Does not add the document library file version to the database.
*
* @param fileVersionId the primary key for the new document library file version
* @return the new document library file version
*/
public static com.liferay.portlet.documentlibrary.model.DLFileVersion createDLFileVersion(
long fileVersionId) {
return getService().createDLFileVersion(fileVersionId);
}
/**
* Deletes the document library file version with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param fileVersionId the primary key of the document library file version
* @return the document library file version that was removed
* @throws PortalException if a document library file version with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.documentlibrary.model.DLFileVersion deleteDLFileVersion(
long fileVersionId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().deleteDLFileVersion(fileVersionId);
}
/**
* Deletes the document library file version from the database. Also notifies the appropriate model listeners.
*
* @param dlFileVersion the document library file version
* @return the document library file version that was removed
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.documentlibrary.model.DLFileVersion deleteDLFileVersion(
com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().deleteDLFileVersion(dlFileVersion);
}
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
return getService().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 static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().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 {@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.DLFileVersionModelImpl}. 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 static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQuery(dynamicQuery, start, 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 {@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.DLFileVersionModelImpl}. 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 static 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 {
return getService()
.dynamicQuery(dynamicQuery, start, end, orderByComparator);
}
/**
* 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 static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQueryCount(dynamicQuery);
}
/**
* 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 static 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 {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersion(
long fileVersionId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().fetchDLFileVersion(fileVersionId);
}
/**
* Returns the document library file version with the matching UUID and company.
*
* @param uuid the document library file version's UUID
* @param companyId the primary key of the company
* @return the matching document library file version, or null if a matching document library file version could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersionByUuidAndCompanyId(
java.lang.String uuid, long companyId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().fetchDLFileVersionByUuidAndCompanyId(uuid, companyId);
}
/**
* Returns the document library file version matching the UUID and group.
*
* @param uuid the document library file version's UUID
* @param groupId the primary key of the group
* @return the matching document library file version, or null if a matching document library file version could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersionByUuidAndGroupId(
java.lang.String uuid, long groupId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().fetchDLFileVersionByUuidAndGroupId(uuid, groupId);
}
/**
* Returns the document library file version with the primary key.
*
* @param fileVersionId the primary key of the document library file version
* @return the document library file version
* @throws PortalException if a document library file version with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersion(
long fileVersionId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getDLFileVersion(fileVersionId);
}
public static com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getPersistedModel(primaryKeyObj);
}
/**
* Returns the document library file version with the matching UUID and company.
*
* @param uuid the document library file version's UUID
* @param companyId the primary key of the company
* @return the matching document library file version
* @throws PortalException if a matching document library file version could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersionByUuidAndCompanyId(
java.lang.String uuid, long companyId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getDLFileVersionByUuidAndCompanyId(uuid, companyId);
}
/**
* Returns the document library file version matching the UUID and group.
*
* @param uuid the document library file version's UUID
* @param groupId the primary key of the group
* @return the matching document library file version
* @throws PortalException if a matching document library file version could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersionByUuidAndGroupId(
java.lang.String uuid, long groupId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getDLFileVersionByUuidAndGroupId(uuid, groupId);
}
/**
* Returns a range of all the document library file versions.
*
*
* 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.DLFileVersionModelImpl}. 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 file versions
* @param end the upper bound of the range of document library file versions (not inclusive)
* @return the range of document library file versions
* @throws SystemException if a system exception occurred
*/
public static java.util.List getDLFileVersions(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getDLFileVersions(start, end);
}
/**
* Returns the number of document library file versions.
*
* @return the number of document library file versions
* @throws SystemException if a system exception occurred
*/
public static int getDLFileVersionsCount()
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getDLFileVersionsCount();
}
/**
* Updates the document library file version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param dlFileVersion the document library file version
* @return the document library file version that was updated
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.documentlibrary.model.DLFileVersion updateDLFileVersion(
com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().updateDLFileVersion(dlFileVersion);
}
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public static java.lang.String getBeanIdentifier() {
return getService().getBeanIdentifier();
}
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public static void setBeanIdentifier(java.lang.String beanIdentifier) {
getService().setBeanIdentifier(beanIdentifier);
}
public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion(
long fileVersionId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getFileVersion(fileVersionId);
}
public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion(
long fileEntryId, java.lang.String version)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getFileVersion(fileEntryId, version);
}
public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersionByUuidAndGroupId(
java.lang.String uuid, long groupId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getFileVersionByUuidAndGroupId(uuid, groupId);
}
public static java.util.List getFileVersions(
long fileEntryId, int status)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getFileVersions(fileEntryId, status);
}
public static int getFileVersionsCount(long fileEntryId, int status)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getFileVersionsCount(fileEntryId, status);
}
public static com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion(
long fileEntryId, boolean excludeWorkingCopy)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getLatestFileVersion(fileEntryId, excludeWorkingCopy);
}
public static com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion(
long userId, long fileEntryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getLatestFileVersion(userId, fileEntryId);
}
public static void rebuildTree(long companyId)
throws com.liferay.portal.kernel.exception.SystemException {
getService().rebuildTree(companyId);
}
public static DLFileVersionLocalService getService() {
if (_service == null) {
_service = (DLFileVersionLocalService)PortalBeanLocatorUtil.locate(DLFileVersionLocalService.class.getName());
ReferenceRegistry.registerReference(DLFileVersionLocalServiceUtil.class,
"_service");
}
return _service;
}
/**
* @deprecated As of 6.2.0
*/
public void setService(DLFileVersionLocalService service) {
}
private static DLFileVersionLocalService _service;
}