Interface DDLRecordService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseService
- All Known Implementing Classes:
DDLRecordServiceWrapper
@AccessControlled
@CTAware
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface DDLRecordService
extends com.liferay.portal.kernel.service.BaseService
Provides the remote service interface for DDLRecord. Methods of this
service are expected to have security checks based on the propagated JAAS
credentials because this service can be accessed remotely.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddRecord
(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 groupId, long recordSetId, int displayIndex, Map<String, Serializable> fieldsMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a record referencing the record set.void
deleteRecord
(long recordId) Deletes the record and its resources.Returns the OSGi service identifier.getRecord
(long recordId) Returns the record with the ID.getRecords
(long recordSetId) Returns all the records matching the record set IDvoid
revertRecord
(long recordId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) Reverts the record to a given version.updateRecord
(long recordId, boolean majorVersion, int displayIndex, com.liferay.dynamic.data.mapping.storage.DDMFormValues ddmFormValues, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates a record, replacing its display index and values.updateRecord
(long recordId, int displayIndex, Map<String, Serializable> fieldsMap, boolean mergeFields, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates a record, replacing its display index and values.
-
Method Details
-
addRecord
DDLRecord addRecord(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:
groupId
- 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
DDLRecord addRecord(long groupId, long recordSetId, int displayIndex, Map<String, Serializable> fieldsMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalExceptionAdds a record referencing the record set.- Parameters:
groupId
- 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 viewfieldsMap
- the record values. The fieldsMap is a map of field names and its serializable values.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
-
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
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
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
@Transactional(propagation=SUPPORTS, readOnly=true) List<DDLRecord> getRecords(long recordSetId) throws com.liferay.portal.kernel.exception.PortalException Returns all the records matching the record set ID- Parameters:
recordSetId
- the record's record set ID- Returns:
- the matching records
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
revertRecord
void revertRecord(long recordId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Reverts the record to a given version.- Parameters:
recordId
- the primary key of the recordversion
- the version to be revertedserviceContext
- 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
-
updateRecord
DDLRecord updateRecord(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 a record, replacing its display index and values.- Parameters:
recordId
- 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
DDLRecord updateRecord(long recordId, int displayIndex, Map<String, Serializable> fieldsMap, boolean mergeFields, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalExceptionUpdates a record, replacing its display index and values.- Parameters:
recordId
- the primary key of the recorddisplayIndex
- the index position in which the record is displayed in the spreadsheet viewfieldsMap
- the record values. The fieldsMap is a map of field names and its serializable values.mergeFields
- whether to merge the new fields with the existing ones; otherwise replace the existing fieldsserviceContext
- 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
-