com.liferay.portlet.documentlibrary.service
Class DLFileEntryMetadataLocalServiceUtil

java.lang.Object
  com.liferay.portlet.documentlibrary.service.DLFileEntryMetadataLocalServiceUtil

public class DLFileEntryMetadataLocalServiceUtil
extends Object

The utility for the document library file entry metadata local service. This utility wraps com.liferay.portlet.documentlibrary.service.impl.DLFileEntryMetadataLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. 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:

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

Constructor Summary

DLFileEntryMetadataLocalServiceUtil()

Method Summary

static DLFileEntryMetadata	addDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata) Adds the document library file entry metadata to the database.
static DLFileEntryMetadata	createDLFileEntryMetadata(long fileEntryMetadataId) Creates a new document library file entry metadata with the primary key.
static DLFileEntryMetadata	deleteDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata) Deletes the document library file entry metadata from the database.
static DLFileEntryMetadata	deleteDLFileEntryMetadata(long fileEntryMetadataId) Deletes the document library file entry metadata with the primary key from the database.
static void	deleteFileEntryMetadata(long fileEntryId)
static void	deleteFileVersionFileEntryMetadata(long fileVersionId)
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static DLFileEntryMetadata	fetchDLFileEntryMetadata(long fileEntryMetadataId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static DLFileEntryMetadata	getDLFileEntryMetadata(long fileEntryMetadataId) Returns the document library file entry metadata with the primary key.
static List<DLFileEntryMetadata>	getDLFileEntryMetadatas(int start, int end) Returns a range of all the document library file entry metadatas.
static int	getDLFileEntryMetadatasCount() Returns the number of document library file entry metadatas.
static DLFileEntryMetadata	getFileEntryMetadata(long fileEntryMetadataId)
static DLFileEntryMetadata	getFileEntryMetadata(long ddmStructureId, long fileVersionId)
static long	getFileEntryMetadataCount(long fileEntryId, long fileVersionId) Deprecated. getFileVersionFileEntryMetadatasCount(long)
static List<DLFileEntryMetadata>	getFileVersionFileEntryMetadatas(long fileVersionId)
static long	getFileVersionFileEntryMetadatasCount(long fileVersionId)
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static DLFileEntryMetadataLocalService	getService()
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(DLFileEntryMetadataLocalService service) Deprecated.
static DLFileEntryMetadata	updateDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata) Updates the document library file entry metadata in the database or adds it if it does not yet exist.
static DLFileEntryMetadata	updateDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata, boolean merge) Updates the document library file entry metadata in the database or adds it if it does not yet exist.
static void	updateFileEntryMetadata(long companyId, List<DDMStructure> ddmStructures, long fileEntryTypeId, long fileEntryId, long fileVersionId, Map<String,Fields> fieldsMap, ServiceContext serviceContext)
static void	updateFileEntryMetadata(long fileEntryTypeId, long fileEntryId, long fileVersionId, Map<String,Fields> fieldsMap, ServiceContext serviceContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DLFileEntryMetadataLocalServiceUtil

public DLFileEntryMetadataLocalServiceUtil()

Method Detail

addDLFileEntryMetadata

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

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

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

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

public static DynamicQuery dynamicQuery()

dynamicQuery

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

public static 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.

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

public static 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.

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

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

fetchDLFileEntryMetadata

public static DLFileEntryMetadata fetchDLFileEntryMetadata(long fileEntryMetadataId)
                                                    throws SystemException

Throws:

SystemException

getDLFileEntryMetadata

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

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getDLFileEntryMetadatas

public static 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.

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

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

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

updateDLFileEntryMetadata

public static DLFileEntryMetadata updateDLFileEntryMetadata(DLFileEntryMetadata dlFileEntryMetadata,
                                                            boolean merge)
                                                     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

merge - whether to merge the document library file entry metadata with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the document library file entry metadata that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

deleteFileEntryMetadata

public static void deleteFileEntryMetadata(long fileEntryId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

deleteFileVersionFileEntryMetadata

public static void deleteFileVersionFileEntryMetadata(long fileVersionId)
                                               throws PortalException,
                                                      SystemException

Throws:

PortalException

SystemException

getFileEntryMetadata

public static DLFileEntryMetadata getFileEntryMetadata(long fileEntryMetadataId)
                                                throws PortalException,
                                                       SystemException

Throws:

PortalException

SystemException

getFileEntryMetadata

public static DLFileEntryMetadata getFileEntryMetadata(long ddmStructureId,
                                                       long fileVersionId)
                                                throws PortalException,
                                                       SystemException

Throws:

PortalException

SystemException

getFileEntryMetadataCount

public static long getFileEntryMetadataCount(long fileEntryId,
                                             long fileVersionId)
                                      throws SystemException

Deprecated. getFileVersionFileEntryMetadatasCount(long)

Throws:

SystemException

getFileVersionFileEntryMetadatas

public static List<DLFileEntryMetadata> getFileVersionFileEntryMetadatas(long fileVersionId)
                                                                  throws SystemException

Throws:

SystemException

getFileVersionFileEntryMetadatasCount

public static long getFileVersionFileEntryMetadatasCount(long fileVersionId)
                                                  throws SystemException

Throws:

SystemException

updateFileEntryMetadata

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

Throws:

PortalException

SystemException

updateFileEntryMetadata

public static void updateFileEntryMetadata(long fileEntryTypeId,
                                           long fileEntryId,
                                           long fileVersionId,
                                           Map<String,Fields> fieldsMap,
                                           ServiceContext serviceContext)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getService

public static DLFileEntryMetadataLocalService getService()

setService

public void setService(DLFileEntryMetadataLocalService service)

Deprecated.