Interface DLFileEntryMetadataLocalService
- All Superinterfaces:
BaseLocalService,CTService<DLFileEntryMetadata>,PersistedModelLocalService
- All Known Implementing Classes:
DLFileEntryMetadataLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata) Adds the document library file entry metadata to the database.createDLFileEntryMetadata(long fileEntryMetadataId) Creates a new document library file entry metadata with the primary key.createPersistedModel(Serializable primaryKeyObj) deleteDLFileEntryMetadata(long fileEntryMetadataId) Deletes the document library file entry metadata with the primary key from the database.deleteDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata) Deletes the document library file entry metadata from the database.voiddeleteFileEntryMetadata(long fileEntryId) voiddeleteFileEntryMetadata(DLFileEntryMetadata fileEntryMetadata) voiddeleteFileEntryMetadataByExternalReferenceCode(String externalReferenceCode, long companyId) voiddeleteFileVersionFileEntryMetadata(long fileVersionId) deletePersistedModel(PersistedModel persistedModel) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <T> List<T>dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> List<T>dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.<T> List<T>dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.fetchDLFileEntryMetadata(long fileEntryMetadataId) fetchDLFileEntryMetadataByExternalReferenceCode(String externalReferenceCode, long companyId) fetchDLFileEntryMetadataByUuidAndCompanyId(String uuid, long companyId) Returns the document library file entry metadata with the matching UUID and company.fetchFileEntryMetadata(long fileEntryMetadataId) fetchFileEntryMetadata(long ddmStructureId, long fileVersionId) getDLFileEntryMetadata(long fileEntryMetadataId) Returns the document library file entry metadata with the primary key.getDLFileEntryMetadataByExternalReferenceCode(String externalReferenceCode, long companyId) getDLFileEntryMetadataByUuidAndCompanyId(String uuid, long companyId) Returns the document library file entry metadata with the matching UUID and company.getDLFileEntryMetadatas(int start, int end) Returns a range of all the document library file entry metadatas.intReturns the number of document library file entry metadatas.getFileEntryMetadata(long fileEntryMetadataId) getFileEntryMetadata(long ddmStructureId, long fileVersionId) getFileVersionFileEntryMetadatas(long fileVersionId) longgetFileVersionFileEntryMetadatasCount(long fileVersionId) Returns the OSGi service identifier.getPersistedModel(Serializable primaryKeyObj) updateDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata) Updates the document library file entry metadata in the database or adds it if it does not yet exist.voidupdateFileEntryMetadata(String externalReferenceCode, long fileEntryTypeId, long fileEntryId, long fileVersionId, Map<String, DDMFormValues> ddmFormValuesMap, ServiceContext serviceContext) voidupdateFileEntryMetadata(String externalReferenceCode, long companyId, List<DDMStructure> ddmStructures, long fileEntryId, long fileVersionId, Map<String, DDMFormValues> ddmFormValuesMap, ServiceContext serviceContext) <R,E extends Throwable>
RupdateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFileEntryMetadata>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addDLFileEntryMetadata
@Indexable(type=REINDEX) DLFileEntryMetadata addDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata) Adds the document library file entry metadata to the database. Also notifies the appropriate model listeners.Important: Inspect DLFileEntryMetadataLocalServiceImpl 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.
- Parameters:
dlFileEntryMetadata- the document library file entry metadata- Returns:
- the document library file entry metadata that was added
-
createDLFileEntryMetadata
@Transactional(enabled=false) 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
-
createPersistedModel
- Specified by:
createPersistedModelin interfacePersistedModelLocalService- Throws:
PortalException
-
deleteDLFileEntryMetadata
@Indexable(type=DELETE) DLFileEntryMetadata deleteDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata) Deletes the document library file entry metadata from the database. Also notifies the appropriate model listeners.Important: Inspect DLFileEntryMetadataLocalServiceImpl 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.
- Parameters:
dlFileEntryMetadata- the document library file entry metadata- Returns:
- the document library file entry metadata that was removed
-
deleteDLFileEntryMetadata
@Indexable(type=DELETE) DLFileEntryMetadata deleteDLFileEntryMetadata(long fileEntryMetadataId) throws PortalException Deletes the document library file entry metadata with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect DLFileEntryMetadataLocalServiceImpl 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.
- 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
-
deleteFileEntryMetadata
- Throws:
PortalException
-
deleteFileEntryMetadata
- Throws:
PortalException
-
deleteFileEntryMetadataByExternalReferenceCode
void deleteFileEntryMetadataByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
deleteFileVersionFileEntryMetadata
- Throws:
PortalException
-
deletePersistedModel
- Specified by:
deletePersistedModelin interfacePersistedModelLocalService- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileEntryMetadataModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileEntryMetadataModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchDLFileEntryMetadata
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntryMetadata fetchDLFileEntryMetadata(long fileEntryMetadataId) -
fetchDLFileEntryMetadataByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntryMetadata fetchDLFileEntryMetadataByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchDLFileEntryMetadataByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntryMetadata fetchDLFileEntryMetadataByUuidAndCompanyId(String uuid, long companyId) Returns the document library file entry metadata with the matching UUID and company.- Parameters:
uuid- the document library file entry metadata's UUIDcompanyId- the primary key of the company- Returns:
- the matching document library file entry metadata, or
nullif a matching document library file entry metadata could not be found
-
fetchFileEntryMetadata
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntryMetadata fetchFileEntryMetadata(long fileEntryMetadataId) -
fetchFileEntryMetadata
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntryMetadata fetchFileEntryMetadata(long ddmStructureId, long fileVersionId) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getDLFileEntryMetadata
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntryMetadata getDLFileEntryMetadata(long fileEntryMetadataId) throws PortalException 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
-
getDLFileEntryMetadataByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntryMetadata getDLFileEntryMetadataByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getDLFileEntryMetadataByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntryMetadata getDLFileEntryMetadataByUuidAndCompanyId(String uuid, long companyId) throws PortalException Returns the document library file entry metadata with the matching UUID and company.- Parameters:
uuid- the document library file entry metadata's UUIDcompanyId- the primary key of the company- Returns:
- the matching document library file entry metadata
- Throws:
PortalException- if a matching document library file entry metadata could not be found
-
getDLFileEntryMetadatas
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntryMetadata> getDLFileEntryMetadatas(int start, int end) Returns a range of all the document library file entry metadatas.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileEntryMetadataModelImpl.- Parameters:
start- the lower bound of the range of document library file entry metadatasend- the upper bound of the range of document library file entry metadatas (not inclusive)- Returns:
- the range of document library file entry metadatas
-
getDLFileEntryMetadatasCount
Returns the number of document library file entry metadatas.- Returns:
- the number of document library file entry metadatas
-
getFileEntryMetadata
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntryMetadata getFileEntryMetadata(long fileEntryMetadataId) throws PortalException - Throws:
PortalException
-
getFileEntryMetadata
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntryMetadata getFileEntryMetadata(long ddmStructureId, long fileVersionId) throws PortalException - Throws:
PortalException
-
getFileVersionFileEntryMetadatas
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntryMetadata> getFileVersionFileEntryMetadatas(long fileVersionId) -
getFileVersionFileEntryMetadatasCount
@Transactional(propagation=SUPPORTS, readOnly=true) long getFileVersionFileEntryMetadatasCount(long fileVersionId) -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getMismatchedCompanyIdFileEntryMetadatas
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntryMetadata> getMismatchedCompanyIdFileEntryMetadatas() -
getNoStructuresFileEntryMetadatas
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntryMetadata> getNoStructuresFileEntryMetadatas() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModelin interfacePersistedModelLocalService- Throws:
PortalException
-
updateDLFileEntryMetadata
@Indexable(type=REINDEX) DLFileEntryMetadata updateDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata) 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.Important: Inspect DLFileEntryMetadataLocalServiceImpl 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.
- Parameters:
dlFileEntryMetadata- the document library file entry metadata- Returns:
- the document library file entry metadata that was updated
-
updateFileEntryMetadata
void updateFileEntryMetadata(String externalReferenceCode, long companyId, List<DDMStructure> ddmStructures, long fileEntryId, long fileVersionId, Map<String, DDMFormValues> ddmFormValuesMap, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
updateFileEntryMetadata
void updateFileEntryMetadata(String externalReferenceCode, long fileEntryTypeId, long fileEntryId, long fileVersionId, Map<String, DDMFormValues> ddmFormValuesMap, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
getCTPersistence
- Specified by:
getCTPersistencein interfaceCTService<DLFileEntryMetadata>
-
getModelClass
- Specified by:
getModelClassin interfaceCTService<DLFileEntryMetadata>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFileEntryMetadata>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunctionin interfaceCTService<DLFileEntryMetadata>- Throws:
E extends Throwable
-