Interface DDLRecordLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService
,com.liferay.portal.kernel.service.change.tracking.CTService<DDLRecord>
,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
DDLRecordLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddDDLRecord
(DDLRecord ddlRecord) Adds the ddl record to the database.addRecord
(long userId, long groupId, long recordSetId, int displayIndex, com.liferay.dynamic.data.mapping.storage.DDMFormValues ddmFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a record referencing the record set.addRecord
(long userId, long groupId, long recordSetId, int displayIndex, Map<String, Serializable> fieldsMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) addRecord
(long userId, long groupId, long ddmStorageId, long ddlRecordSetId, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated.As of Athanasius (7.3.x)addRecord
(long userId, long groupId, long ddmStorageId, long ddlRecordSetId, String className, long classPK, com.liferay.portal.kernel.service.ServiceContext serviceContext) createDDLRecord
(long recordId) Creates a new ddl record with the primary key.com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) deleteDDLRecord
(long recordId) Deletes the ddl record with the primary key from the database.deleteDDLRecord
(DDLRecord ddlRecord) Deletes the ddl record from the database.com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) void
deleteRecord
(long recordId) Deletes the record and its resources.deleteRecord
(DDLRecord record) Deletes the record and its resources.void
deleteRecords
(long recordSetId) Deletes all the record set's records.<T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery
<T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.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
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.fetchDDLRecord
(long recordId) fetchDDLRecordByUuidAndGroupId
(String uuid, long groupId) Returns the ddl record matching the UUID and group.fetchFirstRecord
(String className, long classPK) fetchRecord
(long recordId) Returns the record with the ID.com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
getCompanyRecords
(long companyId, int status, int scope, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator) Returns an ordered range of all the records matching the company, workflow status, and scope.int
getCompanyRecordsCount
(long companyId, int status, int scope) Returns the number of records matching the company, workflow status, and scope.com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDLRecord>
getDDLRecord
(long recordId) Returns the ddl record with the primary key.getDDLRecordByUuidAndGroupId
(String uuid, long groupId) Returns the ddl record matching the UUID and group.getDDLRecords
(int start, int end) Returns a range of all the ddl records.getDDLRecordsByUuidAndCompanyId
(String uuid, long companyId) Returns all the ddl records matching the UUID and company.getDDLRecordsByUuidAndCompanyId
(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator) Returns a range of ddl records matching the UUID and company.int
Returns the number of ddl records.com.liferay.dynamic.data.mapping.storage.DDMFormValues
getDDMFormValues
(long ddmStorageId) Returns the DDM form values object associated with the record storage ID SeeDDLRecord#getDDMFormValues
in thecom.liferay.dynamic.data.lists.api
module.com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
Long[]
getMinAndMaxCompanyRecordIds
(long companyId, int status, int scope) getMinAndMaxCompanyRecords
(long companyId, int status, int scope, long minRecordId, long maxRecordId) Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) getRecord
(long recordId) Returns the record with the ID.getRecords
(long recordSetId) Returns all the records matching the record set IDgetRecords
(long recordSetId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator) Returns an ordered range of all the records matching the record set ID and workflow status.getRecords
(long recordSetId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator) getRecords
(long recordSetId, long userId) Returns all the records matching the record set ID and user ID.getRecords
(long recordSetId, long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator) int
getRecordsCount
(long recordSetId) int
getRecordsCount
(long recordSetId, int status) Returns the number of records matching the record set ID and workflow status.int
getRecordsCount
(long recordSetId, long userId) void
revertRecord
(long userId, long recordId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) Reverts the record to the given version.com.liferay.portal.kernel.search.Hits
search
(com.liferay.portal.kernel.search.SearchContext searchContext) Returns hits to all the records indexed by the search engine matching the search context.com.liferay.portal.kernel.search.BaseModelSearchResult<DDLRecord>
searchDDLRecords
(com.liferay.portal.kernel.search.SearchContext searchContext) Searches for records documents indexed by the search engine.void
updateAsset
(long userId, DDLRecord record, DDLRecordVersion recordVersion, long[] assetCategoryIds, String[] assetTagNames, Locale locale, Double priority) Updates the record's asset with new asset categories, tag names, and link entries, removing and adding them as necessary.updateDDLRecord
(DDLRecord ddlRecord) Updates the ddl record in the database or adds it if it does not yet exist.updateRecord
(long userId, long recordId, boolean majorVersion, int displayIndex, com.liferay.dynamic.data.mapping.storage.DDMFormValues ddmFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the record, replacing its display index and values.updateRecord
(long userId, long recordId, int displayIndex, Map<String, Serializable> fieldsMap, boolean mergeFields, com.liferay.portal.kernel.service.ServiceContext serviceContext) updateRecord
(long userId, long recordId, long ddmStorageId, com.liferay.portal.kernel.service.ServiceContext serviceContext) updateStatus
(long userId, long recordVersionId, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the workflow status of the record version.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDLRecord>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addDDLRecord
Adds the ddl record to the database. Also notifies the appropriate model listeners.Important: Inspect DDLRecordLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
ddlRecord
- the ddl record- Returns:
- the ddl record that was added
-
addRecord
@Indexable(type=REINDEX) DDLRecord addRecord(long userId, long groupId, long recordSetId, int displayIndex, com.liferay.dynamic.data.mapping.storage.DDMFormValues ddmFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Adds a record referencing the record set.- Parameters:
userId
- the primary key of the record's creator/ownergroupId
- the primary key of the record's grouprecordSetId
- the primary key of the record setdisplayIndex
- the index position in which the record is displayed in the spreadsheet viewddmFormValues
- the record values. SeeDDMFormValues
in thedynamic.data.mapping.api
module.serviceContext
- the service context to be applied. This can set the UUID, guest permissions, and group permissions for the record.- Returns:
- the record
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
addRecord
@Indexable(type=REINDEX) DDLRecord addRecord(long userId, long groupId, long recordSetId, int displayIndex, Map<String, Serializable> fieldsMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addRecord
@Deprecated @Indexable(type=REINDEX) DDLRecord addRecord(long userId, long groupId, long ddmStorageId, long ddlRecordSetId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Deprecated.As of Athanasius (7.3.x)- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addRecord
@Indexable(type=REINDEX) DDLRecord addRecord(long userId, long groupId, long ddmStorageId, long ddlRecordSetId, String className, long classPK, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createDDLRecord
Creates a new ddl record with the primary key. Does not add the ddl record to the database.- Parameters:
recordId
- the primary key for the new ddl record- Returns:
- the new ddl record
-
createPersistedModel
com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteDDLRecord
Deletes the ddl record from the database. Also notifies the appropriate model listeners.Important: Inspect DDLRecordLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
ddlRecord
- the ddl record- Returns:
- the ddl record that was removed
-
deleteDDLRecord
@Indexable(type=DELETE) DDLRecord deleteDDLRecord(long recordId) throws com.liferay.portal.kernel.exception.PortalException Deletes the ddl record with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect DDLRecordLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
recordId
- the primary key of the ddl record- Returns:
- the ddl record that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a ddl record with the primary key could not be found
-
deletePersistedModel
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deletePersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteRecord
@Indexable(type=DELETE) @SystemEvent(action=1, type=1) DDLRecord deleteRecord(DDLRecord record) throws com.liferay.portal.kernel.exception.PortalException Deletes the record and its resources.- Parameters:
record
- the record to be deleted- Returns:
- the record
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
deleteRecord
void deleteRecord(long recordId) throws com.liferay.portal.kernel.exception.PortalException Deletes the record and its resources.- Parameters:
recordId
- the primary key of the record to be deleted- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
deleteRecords
void deleteRecords(long recordSetId) throws com.liferay.portal.kernel.exception.PortalException Deletes all the record set's records.- Parameters:
recordSetId
- the primary key of the record set from which to delete records- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.lists.model.impl.DDLRecordModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.lists.model.impl.DDLRecordModelImpl
.- Parameters:
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 (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.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
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchDDLRecord
-
fetchDDLRecordByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) DDLRecord fetchDDLRecordByUuidAndGroupId(String uuid, long groupId) Returns the ddl record matching the UUID and group.- Parameters:
uuid
- the ddl record's UUIDgroupId
- the primary key of the group- Returns:
- the matching ddl record, or
null
if a matching ddl record could not be found
-
fetchFirstRecord
-
fetchRecord
Returns the record with the ID.- Parameters:
recordId
- the primary key of the record- Returns:
- the record with the ID, or
null
if a matching record could not be found
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getCompanyRecords
@Transactional(propagation=SUPPORTS, readOnly=true) List<DDLRecord> getCompanyRecords(long companyId, int status, int scope, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator) Returns an ordered range of all the records matching the company, workflow status, and scope.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil.ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the record's companystatus
- the record's workflow status. For more information search the portal kernel's WorkflowConstants class for constants starting with the "STATUS_" prefix.scope
- the record's scope. For more information search the dynamic-data-lists-api module's DDLRecordSetConstants class for constants starting with the "SCOPE_" prefix.start
- the lower bound of the range of records to returnend
- the upper bound of the range of records to return (not inclusive)orderByComparator
- the comparator to order the records- Returns:
- the range of matching records ordered by the comparator
-
getCompanyRecordsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getCompanyRecordsCount(long companyId, int status, int scope) Returns the number of records matching the company, workflow status, and scope.- Parameters:
companyId
- the primary key of the record's companystatus
- the record's workflow status. For more information search the portal kernel's WorkflowConstants class for constants starting with the "STATUS_" prefix.scope
- the record's scope. For more information search the dynamic-data-lists-api module's DDLRecordSetConstants class for constants starting with the "SCOPE_" prefix.- Returns:
- the number of matching records
-
getDDLRecord
@Transactional(propagation=SUPPORTS, readOnly=true) DDLRecord getDDLRecord(long recordId) throws com.liferay.portal.kernel.exception.PortalException Returns the ddl record with the primary key.- Parameters:
recordId
- the primary key of the ddl record- Returns:
- the ddl record
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a ddl record with the primary key could not be found
-
getDDLRecordByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) DDLRecord getDDLRecordByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException Returns the ddl record matching the UUID and group.- Parameters:
uuid
- the ddl record's UUIDgroupId
- the primary key of the group- Returns:
- the matching ddl record
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a matching ddl record could not be found
-
getDDLRecords
@Transactional(propagation=SUPPORTS, readOnly=true) List<DDLRecord> getDDLRecords(int start, int end) Returns a range of all the ddl records.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.lists.model.impl.DDLRecordModelImpl
.- Parameters:
start
- the lower bound of the range of ddl recordsend
- the upper bound of the range of ddl records (not inclusive)- Returns:
- the range of ddl records
-
getDDLRecordsByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) List<DDLRecord> getDDLRecordsByUuidAndCompanyId(String uuid, long companyId) Returns all the ddl records matching the UUID and company.- Parameters:
uuid
- the UUID of the ddl recordscompanyId
- the primary key of the company- Returns:
- the matching ddl records, or an empty list if no matches were found
-
getDDLRecordsByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) List<DDLRecord> getDDLRecordsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator) Returns a range of ddl records matching the UUID and company.- Parameters:
uuid
- the UUID of the ddl recordscompanyId
- the primary key of the companystart
- the lower bound of the range of ddl recordsend
- the upper bound of the range of ddl records (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching ddl records, or an empty list if no matches were found
-
getDDLRecordsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getDDLRecordsCount()Returns the number of ddl records.- Returns:
- the number of ddl records
-
getDDMFormValues
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.dynamic.data.mapping.storage.DDMFormValues getDDMFormValues(long ddmStorageId) throws com.liferay.dynamic.data.mapping.exception.StorageException Returns the DDM form values object associated with the record storage ID SeeDDLRecord#getDDMFormValues
in thecom.liferay.dynamic.data.lists.api
module.- Parameters:
ddmStorageId
- the storage ID associated with the record- Returns:
- the DDM form values
- Throws:
com.liferay.dynamic.data.mapping.exception.StorageException
-
getExportActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getMinAndMaxCompanyRecordIds
@Transactional(propagation=SUPPORTS, readOnly=true) Long[] getMinAndMaxCompanyRecordIds(long companyId, int status, int scope) -
getMinAndMaxCompanyRecords
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getRecord
@Transactional(propagation=SUPPORTS, readOnly=true) DDLRecord getRecord(long recordId) throws com.liferay.portal.kernel.exception.PortalException Returns the record with the ID.- Parameters:
recordId
- the primary key of the record- Returns:
- the record with the ID
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getRecords
Returns all the records matching the record set ID- Parameters:
recordSetId
- the record's record set ID- Returns:
- the matching records
-
getRecords
@Transactional(propagation=SUPPORTS, readOnly=true) List<DDLRecord> getRecords(long recordSetId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator) Returns an ordered range of all the records matching the record set ID and workflow status.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil.ALL_POS
will return the full result set.- Parameters:
recordSetId
- the record's record set IDstatus
- the record's workflow status. For more information search the portal kernel's WorkflowConstants class for constants starting with the "STATUS_" prefix.start
- the lower bound of the range of records to returnend
- the upper bound of the range of records to return (not inclusive)orderByComparator
- the comparator to order the records- Returns:
- the range of matching records ordered by the comparator
-
getRecords
-
getRecords
@Transactional(propagation=SUPPORTS, readOnly=true) List<DDLRecord> getRecords(long recordSetId, long userId) Returns all the records matching the record set ID and user ID.- Parameters:
recordSetId
- the record's record set IDuserId
- the user ID the records belong to- Returns:
- the list of matching records ordered by the comparator
-
getRecords
-
getRecordsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getRecordsCount(long recordSetId) -
getRecordsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getRecordsCount(long recordSetId, int status) Returns the number of records matching the record set ID and workflow status.- Parameters:
recordSetId
- the record's record set IDstatus
- the record's workflow status. For more information search the portal kernel's WorkflowConstants class for constants starting with the "STATUS_" prefix.- Returns:
- the number of matching records
-
getRecordsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getRecordsCount(long recordSetId, long userId) -
revertRecord
void revertRecord(long userId, long recordId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Reverts the record to the given version.- Parameters:
userId
- the primary key of the user who is reverting the recordrecordId
- the primary key of the recordversion
- the version to revert toserviceContext
- the service context to be applied. This can set the record modified date.- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.search.Hits search(com.liferay.portal.kernel.search.SearchContext searchContext) Returns hits to all the records indexed by the search engine matching the search context.- Parameters:
searchContext
- the search context to be applied for searching records. For more information, seeSearchContext
in theportal-kernel
module.- Returns:
- the hits of the records that matched the search criteria.
-
searchDDLRecords
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.search.BaseModelSearchResult<DDLRecord> searchDDLRecords(com.liferay.portal.kernel.search.SearchContext searchContext) Searches for records documents indexed by the search engine.- Parameters:
searchContext
- the search context to be applied for searching documents. For more information, seeSearchContext
in theportal-kernel
module.- Returns:
- BaseModelSearchResult containing the list of records that matched the search criteria
-
updateAsset
void updateAsset(long userId, DDLRecord record, DDLRecordVersion recordVersion, long[] assetCategoryIds, String[] assetTagNames, Locale locale, Double priority) throws com.liferay.portal.kernel.exception.PortalException Updates the record's asset with new asset categories, tag names, and link entries, removing and adding them as necessary.- Parameters:
userId
- the primary key of the user updating the record's assetrecord
- the recordrecordVersion
- the record versionassetCategoryIds
- the primary keys of the new asset categoriesassetTagNames
- the new asset tag nameslocale
- the locale to apply to the assetpriority
- the new priority- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
updateDDLRecord
Updates the ddl record in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect DDLRecordLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
ddlRecord
- the ddl record- Returns:
- the ddl record that was updated
-
updateRecord
@Indexable(type=REINDEX) DDLRecord updateRecord(long userId, long recordId, boolean majorVersion, int displayIndex, com.liferay.dynamic.data.mapping.storage.DDMFormValues ddmFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Updates the record, replacing its display index and values.- Parameters:
userId
- the primary key of the user updating the recordrecordId
- the primary key of the recordmajorVersion
- whether this update is a major change. A major change increments the record's major version number.displayIndex
- the index position in which the record is displayed in the spreadsheet viewddmFormValues
- the record values. SeeDDMFormValues
in thedynamic.data.mapping.api
module.serviceContext
- the service context to be applied. This can set the record modified date.- Returns:
- the record
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
updateRecord
@Indexable(type=REINDEX) DDLRecord updateRecord(long userId, long recordId, int displayIndex, Map<String, Serializable> fieldsMap, boolean mergeFields, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateRecord
@Indexable(type=REINDEX) DDLRecord updateRecord(long userId, long recordId, long ddmStorageId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateStatus
@Indexable(type=REINDEX) DDLRecord updateStatus(long userId, long recordVersionId, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Updates the workflow status of the record version.- Parameters:
userId
- the primary key of the user updating the record's workflow statusrecordVersionId
- the primary key of the record versionstatus
-serviceContext
- the service context to be applied. This can set the modification date and status date.- Returns:
- the record
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getCTPersistence
@Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDLRecord> getCTPersistence()- Specified by:
getCTPersistence
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<DDLRecord>
-
getModelClass
- Specified by:
getModelClass
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<DDLRecord>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<DDLRecord>, R, throws EE> updateUnsafeFunction)
-