com.liferay.portlet.documentlibrary.service

Interface DLFileEntryMetadataLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

DLFileEntryMetadataLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLFileEntryMetadataLocalService
extends BaseLocalService, PersistedModelLocalService

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 Also:

DLFileEntryMetadataLocalServiceUtil, com.liferay.portlet.documentlibrary.service.base.DLFileEntryMetadataLocalServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
DLFileEntryMetadata	addDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata) Adds the document library file entry metadata to the database.
DLFileEntryMetadata	createDLFileEntryMetadata(long fileEntryMetadataId) Creates a new document library file entry metadata with the primary key.
DLFileEntryMetadata	deleteDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata) Deletes the document library file entry metadata from the database.
DLFileEntryMetadata	deleteDLFileEntryMetadata(long fileEntryMetadataId) Deletes the document library file entry metadata with the primary key from the database.
void	deleteFileEntryMetadata(long fileEntryId)
void	deleteFileVersionFileEntryMetadata(long fileVersionId)
DynamicQuery	dynamicQuery()
java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
DLFileEntryMetadata	fetchDLFileEntryMetadata(long fileEntryMetadataId)
DLFileEntryMetadata	fetchFileEntryMetadata(long fileEntryMetadataId)
DLFileEntryMetadata	fetchFileEntryMetadata(long ddmStructureId, long fileVersionId)
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
DLFileEntryMetadata	getDLFileEntryMetadata(long fileEntryMetadataId) Returns the document library file entry metadata with the primary key.
java.util.List<DLFileEntryMetadata>	getDLFileEntryMetadatas(int start, int end) Returns a range of all the document library file entry metadatas.
int	getDLFileEntryMetadatasCount() Returns the number of document library file entry metadatas.
DLFileEntryMetadata	getFileEntryMetadata(long fileEntryMetadataId)
DLFileEntryMetadata	getFileEntryMetadata(long ddmStructureId, long fileVersionId)
long	getFileEntryMetadataCount(long fileEntryId, long fileVersionId) Deprecated. As of 6.2.0, replaced by getFileVersionFileEntryMetadatasCount(long)
java.util.List<DLFileEntryMetadata>	getFileVersionFileEntryMetadatas(long fileVersionId)
long	getFileVersionFileEntryMetadatasCount(long fileVersionId)
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
DLFileEntryMetadata	updateDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata) Updates the document library file entry metadata in the database or adds it if it does not yet exist.
void	updateFileEntryMetadata(long companyId, java.util.List<DDMStructure> ddmStructures, long fileEntryTypeId, long fileEntryId, long fileVersionId, java.util.Map<java.lang.String,Fields> fieldsMap, ServiceContext serviceContext)
void	updateFileEntryMetadata(long fileEntryTypeId, long fileEntryId, long fileVersionId, java.util.Map<java.lang.String,Fields> fieldsMap, ServiceContext serviceContext)

Method Detail

addDLFileEntryMetadata

@Indexable(type=REINDEX)
DLFileEntryMetadata addDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata)
                                           throws SystemException

Adds the document library file entry metadata to the database. Also notifies the appropriate model listeners.

Parameters:

dlFileEntryMetadata - the document library file entry metadata

Returns:

the document library file entry metadata that was added

Throws:

SystemException - if a system exception occurred

createDLFileEntryMetadata

DLFileEntryMetadata createDLFileEntryMetadata(long fileEntryMetadataId)

Creates a new document library file entry metadata with the primary key. Does not add the document library file entry metadata to the database.

Parameters:

fileEntryMetadataId - the primary key for the new document library file entry metadata

Returns:

the new document library file entry metadata

deleteDLFileEntryMetadata

@Indexable(type=DELETE)
DLFileEntryMetadata deleteDLFileEntryMetadata(long fileEntryMetadataId)
                                              throws PortalException,
                                                     SystemException

Deletes the document library file entry metadata with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

fileEntryMetadataId - the primary key of the document library file entry metadata

Returns:

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

SystemException - if a system exception occurred

deleteDLFileEntryMetadata

@Indexable(type=DELETE)
DLFileEntryMetadata deleteDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata)
                                              throws SystemException

Deletes the document library file entry metadata from the database. Also notifies the appropriate model listeners.

Parameters:

dlFileEntryMetadata - the document library file entry metadata

Returns:

the document library file entry metadata that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                            throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end)
                            throws 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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end,
                          OrderByComparator orderByComparator)
                            throws 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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchDLFileEntryMetadata

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntryMetadata fetchDLFileEntryMetadata(long fileEntryMetadataId)
                                             throws SystemException

Throws:

SystemException

getDLFileEntryMetadata

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntryMetadata getDLFileEntryMetadata(long fileEntryMetadataId)
                                           throws PortalException,
                                                  SystemException

Returns the document library file entry metadata with the primary key.

Parameters:

fileEntryMetadataId - the primary key of the document library file entry metadata

Returns:

the document library file entry metadata

Throws:

PortalException - if a document library file entry metadata with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getDLFileEntryMetadatas

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DLFileEntryMetadata> getDLFileEntryMetadatas(int start,
                                                                                                   int end)
                                                            throws SystemException

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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

Parameters:

start - the lower bound of the range of document library file entry metadatas

end - the upper bound of the range of document library file entry metadatas (not inclusive)

Returns:

the range of document library file entry metadatas

Throws:

SystemException - if a system exception occurred

getDLFileEntryMetadatasCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDLFileEntryMetadatasCount()
                                 throws SystemException

Returns the number of document library file entry metadatas.

Returns:

the number of document library file entry metadatas

Throws:

SystemException - if a system exception occurred

updateDLFileEntryMetadata

@Indexable(type=REINDEX)
DLFileEntryMetadata updateDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata)
                                              throws SystemException

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.

Parameters:

dlFileEntryMetadata - the document library file entry metadata

Returns:

the document library file entry metadata that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

deleteFileEntryMetadata

void deleteFileEntryMetadata(long fileEntryId)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

deleteFileVersionFileEntryMetadata

void deleteFileVersionFileEntryMetadata(long fileVersionId)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

fetchFileEntryMetadata

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntryMetadata fetchFileEntryMetadata(long fileEntryMetadataId)
                                           throws SystemException

Throws:

SystemException

fetchFileEntryMetadata

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntryMetadata fetchFileEntryMetadata(long ddmStructureId,
                                                                                  long fileVersionId)
                                           throws SystemException

Throws:

SystemException

getFileEntryMetadata

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntryMetadata getFileEntryMetadata(long fileEntryMetadataId)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

getFileEntryMetadata

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntryMetadata getFileEntryMetadata(long ddmStructureId,
                                                                                long fileVersionId)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

getFileEntryMetadataCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getFileEntryMetadataCount(long fileEntryId,
                                                                      long fileVersionId)
                               throws SystemException

Deprecated. As of 6.2.0, replaced by getFileVersionFileEntryMetadatasCount(long)

Throws:

SystemException

getFileVersionFileEntryMetadatas

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DLFileEntryMetadata> getFileVersionFileEntryMetadatas(long fileVersionId)
                                                                     throws SystemException

Throws:

SystemException

getFileVersionFileEntryMetadatasCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getFileVersionFileEntryMetadatasCount(long fileVersionId)
                                           throws SystemException

Throws:

SystemException

updateFileEntryMetadata

void updateFileEntryMetadata(long companyId,
                           java.util.List<DDMStructure> ddmStructures,
                           long fileEntryTypeId,
                           long fileEntryId,
                           long fileVersionId,
                           java.util.Map<java.lang.String,Fields> fieldsMap,
                           ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

updateFileEntryMetadata

void updateFileEntryMetadata(long fileEntryTypeId,
                           long fileEntryId,
                           long fileVersionId,
                           java.util.Map<java.lang.String,Fields> fieldsMap,
                           ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException