com.liferay.dynamic.data.lists.service

Interface DDLRecordService

All Superinterfaces:

BaseService

All Known Implementing Classes:

DDLRecordServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DDLRecordService
extends 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:

DDLRecordServiceUtil

Method Summary

Modifier and Type	Method and Description
DDLRecord	addRecord(long groupId, long recordSetId, int displayIndex, DDMFormValues ddmFormValues, ServiceContext serviceContext) Adds a record referencing the record set.
void	deleteRecord(long recordId) Deletes the record and its resources.
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
DDLRecord	getRecord(long recordId) Returns the record with the ID.
java.util.List<DDLRecord>	getRecords(long recordSetId) Returns all the records matching the record set ID
void	revertRecord(long recordId, java.lang.String version, ServiceContext serviceContext) Reverts the record to a given version.
DDLRecord	updateRecord(long recordId, boolean majorVersion, int displayIndex, DDMFormValues ddmFormValues, ServiceContext serviceContext) Updates a record, replacing its display index and values.

Method Detail

addRecord

DDLRecord addRecord(long groupId,
                    long recordSetId,
                    int displayIndex,
                    DDMFormValues ddmFormValues,
                    ServiceContext serviceContext)
             throws PortalException

Adds a record referencing the record set.

Parameters:

groupId - the primary key of the record's group

recordSetId - the primary key of the record set

displayIndex - the index position in which the record is displayed in the spreadsheet view

ddmFormValues - the record values. See DDMFormValues in the dynamic.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:

PortalException - if a portal exception occurred

deleteRecord

void deleteRecord(long recordId)
           throws PortalException

Deletes the record and its resources.

Parameters:

recordId - the primary key of the record to be deleted

Throws:

PortalException

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getRecord

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecord getRecord(long recordId)
                                                                                throws PortalException

Returns the record with the ID.

Parameters:

recordId - the primary key of the record

Returns:

the record with the ID

Throws:

PortalException - if a portal exception occurred

getRecords

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DDLRecord> getRecords(long recordSetId)
                                                                                                 throws PortalException

Returns all the records matching the record set ID

Parameters:

recordSetId - the record's record set ID

Returns:

the matching records

Throws:

PortalException - if a portal exception occurred

revertRecord

void revertRecord(long recordId,
                  java.lang.String version,
                  ServiceContext serviceContext)
           throws PortalException

Reverts the record to a given version.

Parameters:

recordId - the primary key of the record

version - the version to be reverted

serviceContext - the service context to be applied. This can set the record modified date.

Throws:

PortalException - if a portal exception occurred

updateRecord

DDLRecord updateRecord(long recordId,
                       boolean majorVersion,
                       int displayIndex,
                       DDMFormValues ddmFormValues,
                       ServiceContext serviceContext)
                throws PortalException

Updates a record, replacing its display index and values.

Parameters:

recordId - the primary key of the record

majorVersion - 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 view

ddmFormValues - the record values. See DDMFormValues in the dynamic.data.mapping.api module.

serviceContext - the service context to be applied. This can set the record modified date.

Returns:

the record

Throws:

PortalException - if a portal exception occurred