public class DLFileEntryTypeLocalServiceUtil
extends Object
com.liferay.portlet.documentlibrary.service.impl.DLFileEntryTypeLocalServiceImpl
and
is an 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.DLFileEntryTypeLocalService
Constructor and Description |
---|
DLFileEntryTypeLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static void |
addDDMStructureLinks(long fileEntryTypeId,
Set<Long> ddmStructureIds)
NOTE FOR DEVELOPERS:
Never modify or reference this interface directly.
|
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 |
createBasicDocumentDLFileEntryType() |
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 DLFileEntryType |
getBasicDocumentDLFileEntryType() |
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) |
public static void addDDMStructureLinks(long fileEntryTypeId, Set<Long> ddmStructureIds)
DLFileEntryTypeLocalServiceUtil
to access the document library file entry type local service. Add custom service methods to com.liferay.portlet.documentlibrary.service.impl.DLFileEntryTypeLocalServiceImpl
and rerun ServiceBuilder to automatically copy the method declarations to this interface.public static DLFileEntryType addDLFileEntryType(DLFileEntryType dlFileEntryType)
dlFileEntryType
- the document library file entry typepublic static void addDLFolderDLFileEntryType(long folderId, DLFileEntryType dlFileEntryType)
public static void addDLFolderDLFileEntryType(long folderId, long fileEntryTypeId)
public static void addDLFolderDLFileEntryTypes(long folderId, List<DLFileEntryType> dlFileEntryTypes)
public static void addDLFolderDLFileEntryTypes(long folderId, long[] fileEntryTypeIds)
public static DLFileEntryType addFileEntryType(long userId, long groupId, String fileEntryTypeKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, long[] ddmStructureIds, ServiceContext serviceContext) throws PortalException
PortalException
public static DLFileEntryType addFileEntryType(long userId, long groupId, String name, String description, long[] ddmStructureIds, ServiceContext serviceContext) throws PortalException
PortalException
public static void cascadeFileEntryTypes(long userId, DLFolder dlFolder) throws PortalException
PortalException
public static void clearDLFolderDLFileEntryTypes(long folderId)
public static DLFileEntryType createBasicDocumentDLFileEntryType() throws NoSuchFileEntryTypeException
NoSuchFileEntryTypeException
public static DLFileEntryType createDLFileEntryType(long fileEntryTypeId)
fileEntryTypeId
- the primary key for the new document library file entry typepublic static DLFileEntryType deleteDLFileEntryType(DLFileEntryType dlFileEntryType)
dlFileEntryType
- the document library file entry typepublic static DLFileEntryType deleteDLFileEntryType(long fileEntryTypeId) throws PortalException
fileEntryTypeId
- the primary key of the document library file entry typePortalException
- if a document library file entry type with the primary key could not be foundpublic static void deleteDLFolderDLFileEntryType(long folderId, DLFileEntryType dlFileEntryType)
public static void deleteDLFolderDLFileEntryType(long folderId, long fileEntryTypeId)
public static void deleteDLFolderDLFileEntryTypes(long folderId, List<DLFileEntryType> dlFileEntryTypes)
public static void deleteDLFolderDLFileEntryTypes(long folderId, long[] fileEntryTypeIds)
public static void deleteFileEntryType(DLFileEntryType dlFileEntryType) throws PortalException
PortalException
public static void deleteFileEntryType(long fileEntryTypeId) throws PortalException
PortalException
public static void deleteFileEntryTypes(long groupId) throws PortalException
PortalException
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
PortalException
public static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.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.
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 (optionally null
)public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static DLFileEntryType fetchDLFileEntryType(long fileEntryTypeId)
public static DLFileEntryType fetchDLFileEntryTypeByUuidAndGroupId(String uuid, long groupId)
uuid
- the document library file entry type's UUIDgroupId
- the primary key of the groupnull
if a matching document library file entry type could not be foundpublic static DLFileEntryType fetchFileEntryType(long fileEntryTypeId)
public static DLFileEntryType fetchFileEntryType(long groupId, String fileEntryTypeKey)
public static ActionableDynamicQuery getActionableDynamicQuery()
public static DLFileEntryType getBasicDocumentDLFileEntryType() throws NoSuchFileEntryTypeException
NoSuchFileEntryTypeException
public static long getDefaultFileEntryTypeId(long folderId) throws PortalException
PortalException
public static DLFileEntryType getDLFileEntryType(long fileEntryTypeId) throws PortalException
fileEntryTypeId
- the primary key of the document library file entry typePortalException
- if a document library file entry type with the primary key could not be foundpublic static DLFileEntryType getDLFileEntryTypeByUuidAndGroupId(String uuid, long groupId) throws PortalException
uuid
- the document library file entry type's UUIDgroupId
- the primary key of the groupPortalException
- if a matching document library file entry type could not be foundpublic static List<DLFileEntryType> getDLFileEntryTypes(int start, int end)
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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.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.
start
- the lower bound of the range of document library file entry typesend
- the upper bound of the range of document library file entry types (not inclusive)public static List<DLFileEntryType> getDLFileEntryTypesByUuidAndCompanyId(String uuid, long companyId)
uuid
- the UUID of the document library file entry typescompanyId
- the primary key of the companypublic static List<DLFileEntryType> getDLFileEntryTypesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<DLFileEntryType> orderByComparator)
uuid
- the UUID of the document library file entry typescompanyId
- the primary key of the companystart
- the lower bound of the range of document library file entry typesend
- the upper bound of the range of document library file entry types (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static int getDLFileEntryTypesCount()
public static List<DLFileEntryType> getDLFolderDLFileEntryTypes(long folderId)
public static List<DLFileEntryType> getDLFolderDLFileEntryTypes(long folderId, int start, int end)
public static List<DLFileEntryType> getDLFolderDLFileEntryTypes(long folderId, int start, int end, OrderByComparator<DLFileEntryType> orderByComparator)
public static int getDLFolderDLFileEntryTypesCount(long folderId)
public static long[] getDLFolderPrimaryKeys(long fileEntryTypeId)
fileEntryTypeId
- the fileEntryTypeId of the document library file entry typepublic static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
public static DLFileEntryType getFileEntryType(long fileEntryTypeId) throws PortalException
PortalException
public static DLFileEntryType getFileEntryType(long groupId, String fileEntryTypeKey) throws PortalException
PortalException
public static List<DLFileEntryType> getFileEntryTypes(long ddmStructureId) throws PortalException
PortalException
public static List<DLFileEntryType> getFileEntryTypes(long[] groupIds)
public static List<DLFileEntryType> getFolderFileEntryTypes(long[] groupIds, long folderId, boolean inherited) throws PortalException
PortalException
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static String getOSGiServiceIdentifier()
public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static boolean hasDLFolderDLFileEntryType(long folderId, long fileEntryTypeId)
public static boolean hasDLFolderDLFileEntryTypes(long folderId)
public static List<DLFileEntryType> search(long companyId, long[] groupIds, String keywords, boolean includeBasicFileEntryType, int start, int end, OrderByComparator<DLFileEntryType> orderByComparator)
public static int searchCount(long companyId, long[] groupIds, String keywords, boolean includeBasicFileEntryType)
public static void setDLFolderDLFileEntryTypes(long folderId, long[] fileEntryTypeIds)
public static void unsetFolderFileEntryTypes(long folderId)
public static void updateDDMStructureLinks(long fileEntryTypeId, Set<Long> ddmStructureIds) throws PortalException
PortalException
public static DLFileEntryType updateDLFileEntryType(DLFileEntryType dlFileEntryType)
dlFileEntryType
- the document library file entry typepublic static DLFileEntry updateFileEntryFileEntryType(DLFileEntry dlFileEntry, ServiceContext serviceContext) throws PortalException
PortalException
public static void updateFileEntryType(long userId, long fileEntryTypeId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, long[] ddmStructureIds, ServiceContext serviceContext) throws PortalException
PortalException
public static void updateFileEntryType(long userId, long fileEntryTypeId, String name, String description, long[] ddmStructureIds, ServiceContext serviceContext) throws PortalException
PortalException
public static void updateFolderFileEntryTypes(DLFolder dlFolder, List<Long> fileEntryTypeIds, long defaultFileEntryTypeId, ServiceContext serviceContext)
public static DLFileEntryTypeLocalService getService()