com.liferay.document.library.kernel.service.DLFileEntryMetadataLocalService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.portal.kernel Show documentation
Show all versions of com.liferay.portal.kernel 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-present 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.document.library.kernel.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.document.library.kernel.model.DLFileEntryMetadata;
import com.liferay.dynamic.data.mapping.kernel.DDMFormValues;
import com.liferay.dynamic.data.mapping.kernel.DDMStructure;
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.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.service.ServiceContext;
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.Map;
/**
* Provides the local service interface for DLFileEntryMetadata. 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 DLFileEntryMetadataLocalServiceUtil
* @see com.liferay.portlet.documentlibrary.service.base.DLFileEntryMetadataLocalServiceBaseImpl
* @see com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface DLFileEntryMetadataLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link DLFileEntryMetadataLocalServiceUtil} to access the document library file entry metadata local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the document library file entry metadata to the database. Also notifies the appropriate model listeners.
*
* @param dlFileEntryMetadata the document library file entry metadata
* @return the document library file entry metadata that was added
*/
@Indexable(type = IndexableType.REINDEX)
public DLFileEntryMetadata addDLFileEntryMetadata(
DLFileEntryMetadata dlFileEntryMetadata);
/**
* Creates a new document library file entry metadata with the primary key. Does not add the document library file entry metadata to the database.
*
* @param fileEntryMetadataId the primary key for the new document library file entry metadata
* @return the new document library file entry metadata
*/
public DLFileEntryMetadata createDLFileEntryMetadata(
long fileEntryMetadataId);
/**
* Deletes the document library file entry metadata from the database. Also notifies the appropriate model listeners.
*
* @param dlFileEntryMetadata the document library file entry metadata
* @return the document library file entry metadata that was removed
*/
@Indexable(type = IndexableType.DELETE)
public DLFileEntryMetadata deleteDLFileEntryMetadata(
DLFileEntryMetadata dlFileEntryMetadata);
/**
* Deletes the document library file entry metadata with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param fileEntryMetadataId the primary key of the document library file entry metadata
* @return the document library file entry metadata that was removed
* @throws PortalException if a document library file entry metadata with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public DLFileEntryMetadata deleteDLFileEntryMetadata(
long fileEntryMetadataId) throws PortalException;
public void deleteFileEntryMetadata(long fileEntryId)
throws PortalException;
public void deleteFileEntryMetadata(DLFileEntryMetadata fileEntryMetadata)
throws PortalException;
public void deleteFileVersionFileEntryMetadata(long fileVersionId)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
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 {@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.DLFileEntryMetadataModelImpl}. 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
*/
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 {@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.DLFileEntryMetadataModelImpl}. 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
*/
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
*/
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
*/
public long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DLFileEntryMetadata fetchDLFileEntryMetadata(
long fileEntryMetadataId);
/**
* Returns the document library file entry metadata with the matching UUID and company.
*
* @param uuid the document library file entry metadata's UUID
* @param companyId the primary key of the company
* @return the matching document library file entry metadata, or null if a matching document library file entry metadata could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DLFileEntryMetadata fetchDLFileEntryMetadataByUuidAndCompanyId(
java.lang.String uuid, long companyId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DLFileEntryMetadata fetchFileEntryMetadata(long ddmStructureId,
long fileVersionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DLFileEntryMetadata fetchFileEntryMetadata(long fileEntryMetadataId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
/**
* Returns the document library file entry metadata with the primary key.
*
* @param fileEntryMetadataId the primary key of the document library file entry metadata
* @return the document library file entry metadata
* @throws PortalException if a document library file entry metadata with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DLFileEntryMetadata getDLFileEntryMetadata(long fileEntryMetadataId)
throws PortalException;
/**
* Returns the document library file entry metadata with the matching UUID and company.
*
* @param uuid the document library file entry metadata's UUID
* @param companyId the primary key of the company
* @return the matching document library file entry metadata
* @throws PortalException if a matching document library file entry metadata could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DLFileEntryMetadata getDLFileEntryMetadataByUuidAndCompanyId(
java.lang.String uuid, long companyId) throws PortalException;
/**
* Returns a range of all the document library file entry metadatas.
*
*
* 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.DLFileEntryMetadataModelImpl}. 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 entry metadatas
* @param end the upper bound of the range of document library file entry metadatas (not inclusive)
* @return the range of document library file entry metadatas
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getDLFileEntryMetadatas(int start, int end);
/**
* Returns the number of document library file entry metadatas.
*
* @return the number of document library file entry metadatas
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getDLFileEntryMetadatasCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DLFileEntryMetadata getFileEntryMetadata(long ddmStructureId,
long fileVersionId) throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DLFileEntryMetadata getFileEntryMetadata(long fileEntryMetadataId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getFileVersionFileEntryMetadatas(
long fileVersionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long getFileVersionFileEntryMetadatasCount(long fileVersionId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMismatchedCompanyIdFileEntryMetadatas();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getNoStructuresFileEntryMetadatas();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public java.lang.String getOSGiServiceIdentifier();
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Updates the document library file entry metadata in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param dlFileEntryMetadata the document library file entry metadata
* @return the document library file entry metadata that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public DLFileEntryMetadata updateDLFileEntryMetadata(
DLFileEntryMetadata dlFileEntryMetadata);
public void updateFileEntryMetadata(long companyId,
List ddmStructures, long fileEntryId, long fileVersionId,
Map ddmFormValuesMap,
ServiceContext serviceContext) throws PortalException;
public void updateFileEntryMetadata(long fileEntryTypeId, long fileEntryId,
long fileVersionId,
Map ddmFormValuesMap,
ServiceContext serviceContext) throws PortalException;
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy