Liferay 7.0-ce-b4

com.liferay.portlet.documentlibrary.service
Interface DLFileEntryMetadataLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
DLFileEntryMetadataLocalServiceBaseImpl, DLFileEntryMetadataLocalServiceImpl, 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.

See Also:
DLFileEntryMetadataLocalServiceUtil, DLFileEntryMetadataLocalServiceBaseImpl, DLFileEntryMetadataLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 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(DLFileEntryMetadata fileEntryMetadata)
           
 void deleteFileEntryMetadata(long fileEntryId)
           
 void deleteFileVersionFileEntryMetadata(long fileVersionId)
           
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 DynamicQuery dynamicQuery()
           
<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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 DLFileEntryMetadata fetchDLFileEntryMetadata(long fileEntryMetadataId)
           
 DLFileEntryMetadata fetchDLFileEntryMetadataByUuidAndCompanyId(String uuid, long companyId)
          Returns the document library file entry metadata with the matching UUID and company.
 DLFileEntryMetadata fetchFileEntryMetadata(long fileEntryMetadataId)
           
 DLFileEntryMetadata fetchFileEntryMetadata(long ddmStructureId, long fileVersionId)
           
 ActionableDynamicQuery getActionableDynamicQuery()
           
 DLFileEntryMetadata getDLFileEntryMetadata(long fileEntryMetadataId)
          Returns the document library file entry metadata with the primary key.
 DLFileEntryMetadata getDLFileEntryMetadataByUuidAndCompanyId(String uuid, long companyId)
          Returns the document library file entry metadata with the matching UUID and company.
 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)
 List<DLFileEntryMetadata> getFileVersionFileEntryMetadatas(long fileVersionId)
           
 long getFileVersionFileEntryMetadatasCount(long fileVersionId)
           
 IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
 List<DLFileEntryMetadata> getMismatchedCompanyIdFileEntryMetadatas()
           
 List<DLFileEntryMetadata> getNoStructuresFileEntryMetadatas()
           
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 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, List<DDMStructure> ddmStructures, long fileEntryId, long fileVersionId, Map<String,DDMFormValues> ddmFormValuesMap, ServiceContext serviceContext)
           
 void updateFileEntryMetadata(long fileEntryTypeId, long fileEntryId, long fileVersionId, Map<String,DDMFormValues> ddmFormValuesMap, ServiceContext serviceContext)
           
 

Method Detail

addDLFileEntryMetadata

@Indexable(type=REINDEX)
DLFileEntryMetadata addDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata)
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

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(DLFileEntryMetadata dlFileEntryMetadata)
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

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.

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

void deleteFileEntryMetadata(long fileEntryId)
                             throws PortalException
Throws:
PortalException

deleteFileEntryMetadata

void deleteFileEntryMetadata(DLFileEntryMetadata fileEntryMetadata)
                             throws PortalException
Throws:
PortalException

deleteFileVersionFileEntryMetadata

void deleteFileVersionFileEntryMetadata(long fileVersionId)
                                        throws PortalException
Throws:
PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<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

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

dynamicQuery

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

dynamicQueryCount

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

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - 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)

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 UUID
companyId - the primary key of the company
Returns:
the matching document library file entry metadata, or null if a matching document library file entry metadata could not be found

fetchFileEntryMetadata

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

fetchFileEntryMetadata

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

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

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 UUID
companyId - 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 - 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

getDLFileEntryMetadatasCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int 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 ddmStructureId,
                                                                                  long fileVersionId)
                                         throws PortalException
Throws:
PortalException

getFileEntryMetadata

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

getFileEntryMetadataCount

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getFileEntryMetadataCount(long fileEntryId,
                                                                                   long fileVersionId)
Deprecated. As of 6.2.0, replaced by getFileVersionFileEntryMetadatasCount(long)


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:
getPersistedModel in interface PersistedModelLocalService
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.

Parameters:
dlFileEntryMetadata - the document library file entry metadata
Returns:
the document library file entry metadata that was updated

updateFileEntryMetadata

void updateFileEntryMetadata(long companyId,
                             List<DDMStructure> ddmStructures,
                             long fileEntryId,
                             long fileVersionId,
                             Map<String,DDMFormValues> ddmFormValuesMap,
                             ServiceContext serviceContext)
                             throws PortalException
Throws:
PortalException

updateFileEntryMetadata

void updateFileEntryMetadata(long fileEntryTypeId,
                             long fileEntryId,
                             long fileVersionId,
                             Map<String,DDMFormValues> ddmFormValuesMap,
                             ServiceContext serviceContext)
                             throws PortalException
Throws:
PortalException

Liferay 7.0-ce-b4