Liferay 7.0-ce-b4

com.liferay.portlet.documentlibrary.service
Class DLFileEntryMetadataLocalServiceUtil

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

@ProviderType
public class DLFileEntryMetadataLocalServiceUtil
extends Object

Provides the local service utility for DLFileEntryMetadata. This utility wraps DLFileEntryMetadataLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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, DLFileEntryMetadataLocalServiceBaseImpl, DLFileEntryMetadataLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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

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

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

public static void deleteFileEntryMetadata(long fileEntryId)
                                    throws PortalException
Throws:
PortalException

deleteFileEntryMetadata

public static void deleteFileEntryMetadata(DLFileEntryMetadata fileEntryMetadata)
                                    throws PortalException
Throws:
PortalException

deleteFileVersionFileEntryMetadata

public static void deleteFileVersionFileEntryMetadata(long fileVersionId)
                                               throws PortalException
Throws:
PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

public static DLFileEntryMetadata fetchDLFileEntryMetadata(long fileEntryMetadataId)

fetchDLFileEntryMetadataByUuidAndCompanyId

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

public static DLFileEntryMetadata fetchFileEntryMetadata(long ddmStructureId,
                                                         long fileVersionId)

fetchFileEntryMetadata

public static DLFileEntryMetadata fetchFileEntryMetadata(long fileEntryMetadataId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getDLFileEntryMetadata

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

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

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

public static int getDLFileEntryMetadatasCount()
Returns the number of document library file entry metadatas.

Returns:
the number of document library file entry metadatas

getFileEntryMetadata

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

getFileEntryMetadata

public static DLFileEntryMetadata getFileEntryMetadata(long fileEntryMetadataId)
                                                throws PortalException
Throws:
PortalException

getFileEntryMetadataCount

@Deprecated
public static long getFileEntryMetadataCount(long fileEntryId,
                                                        long fileVersionId)
Deprecated. As of 6.2.0, replaced by getFileVersionFileEntryMetadatasCount(long)


getFileVersionFileEntryMetadatas

public static List<DLFileEntryMetadata> getFileVersionFileEntryMetadatas(long fileVersionId)

getFileVersionFileEntryMetadatasCount

public static long getFileVersionFileEntryMetadatasCount(long fileVersionId)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMismatchedCompanyIdFileEntryMetadatas

public static List<DLFileEntryMetadata> getMismatchedCompanyIdFileEntryMetadatas()

getNoStructuresFileEntryMetadatas

public static List<DLFileEntryMetadata> getNoStructuresFileEntryMetadatas()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

updateDLFileEntryMetadata

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

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

updateFileEntryMetadata

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

getService

public static DLFileEntryMetadataLocalService getService()

Liferay 7.0-ce-b4