Liferay 7.0-ce-b4

com.liferay.portlet.documentlibrary.service
Class DLFileEntryTypeLocalServiceUtil

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

@ProviderType
public class DLFileEntryTypeLocalServiceUtil
extends Object

Provides the local service utility for DLFileEntryType. This utility wraps com.liferay.portlet.documentlibrary.service.impl.DLFileEntryTypeLocalServiceImpl 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:
DLFileEntryTypeLocalService, com.liferay.portlet.documentlibrary.service.base.DLFileEntryTypeLocalServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLFileEntryTypeLocalServiceImpl

Constructor Summary
DLFileEntryTypeLocalServiceUtil()
           
 
Method Summary
static void addDDMStructureLinks(long fileEntryTypeId, Set<Long> ddmStructureIds)
           
static DLFileEntryType addDLFileEntryType(DLFileEntryType dlFileEntryType)
          Adds the document library file entry type to the database.
static void addDLFolderDLFileEntryType(long folderId, DLFileEntryType dlFileEntryType)
           
static void addDLFolderDLFileEntryType(long folderId, long fileEntryTypeId)
           
static void addDLFolderDLFileEntryTypes(long folderId, List<DLFileEntryType> DLFileEntryTypes)
           
static void addDLFolderDLFileEntryTypes(long folderId, long[] fileEntryTypeIds)
           
static DLFileEntryType addFileEntryType(long userId, long groupId, String fileEntryTypeKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, long[] ddmStructureIds, ServiceContext serviceContext)
           
static DLFileEntryType addFileEntryType(long userId, long groupId, String name, String description, long[] ddmStructureIds, ServiceContext serviceContext)
           
static void cascadeFileEntryTypes(long userId, DLFolder dlFolder)
           
static void clearDLFolderDLFileEntryTypes(long folderId)
           
static DLFileEntryType createDLFileEntryType(long fileEntryTypeId)
          Creates a new document library file entry type with the primary key.
static DLFileEntryType deleteDLFileEntryType(DLFileEntryType dlFileEntryType)
          Deletes the document library file entry type from the database.
static DLFileEntryType deleteDLFileEntryType(long fileEntryTypeId)
          Deletes the document library file entry type with the primary key from the database.
static void deleteDLFolderDLFileEntryType(long folderId, DLFileEntryType dlFileEntryType)
           
static void deleteDLFolderDLFileEntryType(long folderId, long fileEntryTypeId)
           
static void deleteDLFolderDLFileEntryTypes(long folderId, List<DLFileEntryType> DLFileEntryTypes)
           
static void deleteDLFolderDLFileEntryTypes(long folderId, long[] fileEntryTypeIds)
           
static void deleteFileEntryType(DLFileEntryType dlFileEntryType)
           
static void deleteFileEntryType(long fileEntryTypeId)
           
static void deleteFileEntryTypes(long groupId)
           
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 DLFileEntryType fetchDLFileEntryType(long fileEntryTypeId)
           
static DLFileEntryType fetchDLFileEntryTypeByUuidAndGroupId(String uuid, long groupId)
          Returns the document library file entry type matching the UUID and group.
static DLFileEntryType fetchFileEntryType(long fileEntryTypeId)
           
static DLFileEntryType fetchFileEntryType(long groupId, String fileEntryTypeKey)
           
static ActionableDynamicQuery getActionableDynamicQuery()
           
static long getDefaultFileEntryTypeId(long folderId)
           
static DLFileEntryType getDLFileEntryType(long fileEntryTypeId)
          Returns the document library file entry type with the primary key.
static DLFileEntryType getDLFileEntryTypeByUuidAndGroupId(String uuid, long groupId)
          Returns the document library file entry type matching the UUID and group.
static List<DLFileEntryType> getDLFileEntryTypes(int start, int end)
          Returns a range of all the document library file entry types.
static List<DLFileEntryType> getDLFileEntryTypesByUuidAndCompanyId(String uuid, long companyId)
          Returns all the document library file entry types matching the UUID and company.
static List<DLFileEntryType> getDLFileEntryTypesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<DLFileEntryType> orderByComparator)
          Returns a range of document library file entry types matching the UUID and company.
static int getDLFileEntryTypesCount()
          Returns the number of document library file entry types.
static List<DLFileEntryType> getDLFolderDLFileEntryTypes(long folderId)
           
static List<DLFileEntryType> getDLFolderDLFileEntryTypes(long folderId, int start, int end)
           
static List<DLFileEntryType> getDLFolderDLFileEntryTypes(long folderId, int start, int end, OrderByComparator<DLFileEntryType> orderByComparator)
           
static int getDLFolderDLFileEntryTypesCount(long folderId)
           
static long[] getDLFolderPrimaryKeys(long fileEntryTypeId)
          Returns the folderIds of the document library folders associated with the document library file entry type.
static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
static DLFileEntryType getFileEntryType(long fileEntryTypeId)
           
static DLFileEntryType getFileEntryType(long groupId, String fileEntryTypeKey)
           
static List<DLFileEntryType> getFileEntryTypes(long ddmStructureId)
           
static List<DLFileEntryType> getFileEntryTypes(long[] groupIds)
           
static List<DLFileEntryType> getFolderFileEntryTypes(long[] groupIds, long folderId, boolean inherited)
           
static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
static String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static DLFileEntryTypeLocalService getService()
           
static boolean hasDLFolderDLFileEntryType(long folderId, long fileEntryTypeId)
           
static boolean hasDLFolderDLFileEntryTypes(long folderId)
           
static List<DLFileEntryType> search(long companyId, long[] groupIds, String keywords, boolean includeBasicFileEntryType, int start, int end, OrderByComparator<DLFileEntryType> orderByComparator)
           
static int searchCount(long companyId, long[] groupIds, String keywords, boolean includeBasicFileEntryType)
           
static void setDLFolderDLFileEntryTypes(long folderId, long[] fileEntryTypeIds)
           
static void unsetFolderFileEntryTypes(long folderId)
           
static void updateDDMStructureLinks(long fileEntryTypeId, Set<Long> ddmStructureIds)
           
static DLFileEntryType updateDLFileEntryType(DLFileEntryType dlFileEntryType)
          Updates the document library file entry type in the database or adds it if it does not yet exist.
static DLFileEntry updateFileEntryFileEntryType(DLFileEntry dlFileEntry, ServiceContext serviceContext)
           
static void updateFileEntryType(long userId, long fileEntryTypeId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, long[] ddmStructureIds, ServiceContext serviceContext)
           
static void updateFileEntryType(long userId, long fileEntryTypeId, String name, String description, long[] ddmStructureIds, ServiceContext serviceContext)
           
static void updateFolderFileEntryTypes(DLFolder dlFolder, List<Long> fileEntryTypeIds, long defaultFileEntryTypeId, ServiceContext serviceContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DLFileEntryTypeLocalServiceUtil

public DLFileEntryTypeLocalServiceUtil()
Method Detail

addDDMStructureLinks

public static void addDDMStructureLinks(long fileEntryTypeId,
                                        Set<Long> ddmStructureIds)

addDLFileEntryType

public static DLFileEntryType addDLFileEntryType(DLFileEntryType dlFileEntryType)
Adds the document library file entry type to the database. Also notifies the appropriate model listeners.

Parameters:
dlFileEntryType - the document library file entry type
Returns:
the document library file entry type that was added

addDLFolderDLFileEntryType

public static void addDLFolderDLFileEntryType(long folderId,
                                              DLFileEntryType dlFileEntryType)

addDLFolderDLFileEntryType

public static void addDLFolderDLFileEntryType(long folderId,
                                              long fileEntryTypeId)

addDLFolderDLFileEntryTypes

public static void addDLFolderDLFileEntryTypes(long folderId,
                                               List<DLFileEntryType> DLFileEntryTypes)

addDLFolderDLFileEntryTypes

public static void addDLFolderDLFileEntryTypes(long folderId,
                                               long[] fileEntryTypeIds)

addFileEntryType

public static DLFileEntryType addFileEntryType(long userId,
                                               long groupId,
                                               String fileEntryTypeKey,
                                               Map<Locale,String> nameMap,
                                               Map<Locale,String> descriptionMap,
                                               long[] ddmStructureIds,
                                               ServiceContext serviceContext)
                                        throws PortalException
Throws:
PortalException

addFileEntryType

public static DLFileEntryType addFileEntryType(long userId,
                                               long groupId,
                                               String name,
                                               String description,
                                               long[] ddmStructureIds,
                                               ServiceContext serviceContext)
                                        throws PortalException
Throws:
PortalException

cascadeFileEntryTypes

public static void cascadeFileEntryTypes(long userId,
                                         DLFolder dlFolder)
                                  throws PortalException
Throws:
PortalException

clearDLFolderDLFileEntryTypes

public static void clearDLFolderDLFileEntryTypes(long folderId)

createDLFileEntryType

public static DLFileEntryType createDLFileEntryType(long fileEntryTypeId)
Creates a new document library file entry type with the primary key. Does not add the document library file entry type to the database.

Parameters:
fileEntryTypeId - the primary key for the new document library file entry type
Returns:
the new document library file entry type

deleteDLFileEntryType

public static DLFileEntryType deleteDLFileEntryType(DLFileEntryType dlFileEntryType)
Deletes the document library file entry type from the database. Also notifies the appropriate model listeners.

Parameters:
dlFileEntryType - the document library file entry type
Returns:
the document library file entry type that was removed

deleteDLFileEntryType

public static DLFileEntryType deleteDLFileEntryType(long fileEntryTypeId)
                                             throws PortalException
Deletes the document library file entry type with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
fileEntryTypeId - the primary key of the document library file entry type
Returns:
the document library file entry type that was removed
Throws:
PortalException - if a document library file entry type with the primary key could not be found

deleteDLFolderDLFileEntryType

public static void deleteDLFolderDLFileEntryType(long folderId,
                                                 DLFileEntryType dlFileEntryType)

deleteDLFolderDLFileEntryType

public static void deleteDLFolderDLFileEntryType(long folderId,
                                                 long fileEntryTypeId)

deleteDLFolderDLFileEntryTypes

public static void deleteDLFolderDLFileEntryTypes(long folderId,
                                                  List<DLFileEntryType> DLFileEntryTypes)

deleteDLFolderDLFileEntryTypes

public static void deleteDLFolderDLFileEntryTypes(long folderId,
                                                  long[] fileEntryTypeIds)

deleteFileEntryType

public static void deleteFileEntryType(DLFileEntryType dlFileEntryType)
                                throws PortalException
Throws:
PortalException

deleteFileEntryType

public static void deleteFileEntryType(long fileEntryTypeId)
                                throws PortalException
Throws:
PortalException

deleteFileEntryTypes

public static void deleteFileEntryTypes(long groupId)
                                 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 com.liferay.portlet.documentlibrary.model.impl.DLFileEntryTypeModelImpl. 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 com.liferay.portlet.documentlibrary.model.impl.DLFileEntryTypeModelImpl. 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

fetchDLFileEntryType

public static DLFileEntryType fetchDLFileEntryType(long fileEntryTypeId)

fetchDLFileEntryTypeByUuidAndGroupId

public static DLFileEntryType fetchDLFileEntryTypeByUuidAndGroupId(String uuid,
                                                                   long groupId)
Returns the document library file entry type matching the UUID and group.

Parameters:
uuid - the document library file entry type's UUID
groupId - the primary key of the group
Returns:
the matching document library file entry type, or null if a matching document library file entry type could not be found

fetchFileEntryType

public static DLFileEntryType fetchFileEntryType(long fileEntryTypeId)

fetchFileEntryType

public static DLFileEntryType fetchFileEntryType(long groupId,
                                                 String fileEntryTypeKey)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getDLFileEntryType

public static DLFileEntryType getDLFileEntryType(long fileEntryTypeId)
                                          throws PortalException
Returns the document library file entry type with the primary key.

Parameters:
fileEntryTypeId - the primary key of the document library file entry type
Returns:
the document library file entry type
Throws:
PortalException - if a document library file entry type with the primary key could not be found

getDLFileEntryTypeByUuidAndGroupId

public static DLFileEntryType getDLFileEntryTypeByUuidAndGroupId(String uuid,
                                                                 long groupId)
                                                          throws PortalException
Returns the document library file entry type matching the UUID and group.

Parameters:
uuid - the document library file entry type's UUID
groupId - the primary key of the group
Returns:
the matching document library file entry type
Throws:
PortalException - if a matching document library file entry type could not be found

getDLFileEntryTypes

public static List<DLFileEntryType> getDLFileEntryTypes(int start,
                                                        int end)
Returns a range of all the document library file entry types.

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 com.liferay.portlet.documentlibrary.model.impl.DLFileEntryTypeModelImpl. 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 types
end - the upper bound of the range of document library file entry types (not inclusive)
Returns:
the range of document library file entry types

getDLFileEntryTypesByUuidAndCompanyId

public static List<DLFileEntryType> getDLFileEntryTypesByUuidAndCompanyId(String uuid,
                                                                          long companyId)
Returns all the document library file entry types matching the UUID and company.

Parameters:
uuid - the UUID of the document library file entry types
companyId - the primary key of the company
Returns:
the matching document library file entry types, or an empty list if no matches were found

getDLFileEntryTypesByUuidAndCompanyId

public static List<DLFileEntryType> getDLFileEntryTypesByUuidAndCompanyId(String uuid,
                                                                          long companyId,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator<DLFileEntryType> orderByComparator)
Returns a range of document library file entry types matching the UUID and company.

Parameters:
uuid - the UUID of the document library file entry types
companyId - the primary key of the company
start - the lower bound of the range of document library file entry types
end - the upper bound of the range of document library file entry types (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the range of matching document library file entry types, or an empty list if no matches were found

getDLFileEntryTypesCount

public static int getDLFileEntryTypesCount()
Returns the number of document library file entry types.

Returns:
the number of document library file entry types

getDLFolderDLFileEntryTypes

public static List<DLFileEntryType> getDLFolderDLFileEntryTypes(long folderId)

getDLFolderDLFileEntryTypes

public static List<DLFileEntryType> getDLFolderDLFileEntryTypes(long folderId,
                                                                int start,
                                                                int end)

getDLFolderDLFileEntryTypes

public static List<DLFileEntryType> getDLFolderDLFileEntryTypes(long folderId,
                                                                int start,
                                                                int end,
                                                                OrderByComparator<DLFileEntryType> orderByComparator)

getDLFolderDLFileEntryTypesCount

public static int getDLFolderDLFileEntryTypesCount(long folderId)

getDLFolderPrimaryKeys

public static long[] getDLFolderPrimaryKeys(long fileEntryTypeId)
Returns the folderIds of the document library folders associated with the document library file entry type.

Parameters:
fileEntryTypeId - the fileEntryTypeId of the document library file entry type
Returns:
long[] the folderIds of document library folders associated with the document library file entry type

getDefaultFileEntryTypeId

public static long getDefaultFileEntryTypeId(long folderId)
                                      throws PortalException
Throws:
PortalException

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getFileEntryType

public static DLFileEntryType getFileEntryType(long fileEntryTypeId)
                                        throws PortalException
Throws:
PortalException

getFileEntryType

public static DLFileEntryType getFileEntryType(long groupId,
                                               String fileEntryTypeKey)
                                        throws PortalException
Throws:
PortalException

getFileEntryTypes

public static List<DLFileEntryType> getFileEntryTypes(long ddmStructureId)
                                               throws PortalException
Throws:
PortalException

getFileEntryTypes

public static List<DLFileEntryType> getFileEntryTypes(long[] groupIds)

getFolderFileEntryTypes

public static List<DLFileEntryType> getFolderFileEntryTypes(long[] groupIds,
                                                            long folderId,
                                                            boolean inherited)
                                                     throws PortalException
Throws:
PortalException

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

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

hasDLFolderDLFileEntryType

public static boolean hasDLFolderDLFileEntryType(long folderId,
                                                 long fileEntryTypeId)

hasDLFolderDLFileEntryTypes

public static boolean hasDLFolderDLFileEntryTypes(long folderId)

search

public static List<DLFileEntryType> search(long companyId,
                                           long[] groupIds,
                                           String keywords,
                                           boolean includeBasicFileEntryType,
                                           int start,
                                           int end,
                                           OrderByComparator<DLFileEntryType> orderByComparator)

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              String keywords,
                              boolean includeBasicFileEntryType)

setDLFolderDLFileEntryTypes

public static void setDLFolderDLFileEntryTypes(long folderId,
                                               long[] fileEntryTypeIds)

unsetFolderFileEntryTypes

public static void unsetFolderFileEntryTypes(long folderId)

updateDDMStructureLinks

public static void updateDDMStructureLinks(long fileEntryTypeId,
                                           Set<Long> ddmStructureIds)
                                    throws PortalException
Throws:
PortalException

updateDLFileEntryType

public static DLFileEntryType updateDLFileEntryType(DLFileEntryType dlFileEntryType)
Updates the document library file entry type in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
dlFileEntryType - the document library file entry type
Returns:
the document library file entry type that was updated

updateFileEntryFileEntryType

public static DLFileEntry updateFileEntryFileEntryType(DLFileEntry dlFileEntry,
                                                       ServiceContext serviceContext)
                                                throws PortalException
Throws:
PortalException

updateFileEntryType

public static void updateFileEntryType(long userId,
                                       long fileEntryTypeId,
                                       String name,
                                       String description,
                                       long[] ddmStructureIds,
                                       ServiceContext serviceContext)
                                throws PortalException
Throws:
PortalException

updateFileEntryType

public static void updateFileEntryType(long userId,
                                       long fileEntryTypeId,
                                       Map<Locale,String> nameMap,
                                       Map<Locale,String> descriptionMap,
                                       long[] ddmStructureIds,
                                       ServiceContext serviceContext)
                                throws PortalException
Throws:
PortalException

updateFolderFileEntryTypes

public static void updateFolderFileEntryTypes(DLFolder dlFolder,
                                              List<Long> fileEntryTypeIds,
                                              long defaultFileEntryTypeId,
                                              ServiceContext serviceContext)

getService

public static DLFileEntryTypeLocalService getService()

Liferay 7.0-ce-b4