Liferay 6.2-ce-ga5

com.liferay.portlet.dynamicdatalists.service
Interface DDLRecordLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
DDLRecordLocalServiceBaseImpl, DDLRecordLocalServiceImpl, DDLRecordLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DDLRecordLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for DDLRecord. 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:
DDLRecordLocalServiceUtil, DDLRecordLocalServiceBaseImpl, DDLRecordLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 DDLRecord addDDLRecord(DDLRecord ddlRecord)
          Adds the d d l record to the database.
 DDLRecord addRecord(long userId, long groupId, long recordSetId, int displayIndex, Fields fields, ServiceContext serviceContext)
           
 DDLRecord addRecord(long userId, long groupId, long recordSetId, int displayIndex, Map<String,Serializable> fieldsMap, ServiceContext serviceContext)
           
 DDLRecord createDDLRecord(long recordId)
          Creates a new d d l record with the primary key.
 DDLRecord deleteDDLRecord(DDLRecord ddlRecord)
          Deletes the d d l record from the database.
 DDLRecord deleteDDLRecord(long recordId)
          Deletes the d d l record with the primary key from the database.
 void deleteRecord(DDLRecord record)
           
 void deleteRecord(long recordId)
           
 DDLRecord deleteRecordLocale(long recordId, Locale locale, ServiceContext serviceContext)
           
 void deleteRecords(long recordSetId)
           
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 DDLRecord fetchDDLRecord(long recordId)
           
 DDLRecord fetchDDLRecordByUuidAndCompanyId(String uuid, long companyId)
          Returns the d d l record with the matching UUID and company.
 DDLRecord fetchDDLRecordByUuidAndGroupId(String uuid, long groupId)
          Returns the d d l record matching the UUID and group.
 DDLRecord fetchRecord(long recordId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<DDLRecord> getCompanyRecords(long companyId, int status, int scope, int start, int end, OrderByComparator orderByComparator)
           
 List<DDLRecord> getCompanyRecords(long companyId, int scope, int start, int end, OrderByComparator orderByComparator)
          Deprecated. As of 6.2.0, replaced by getCompanyRecords(long, int, int, int, int, OrderByComparator)
 int getCompanyRecordsCount(long companyId, int scope)
          Deprecated. As of 6.2.0, replaced by getCompanyRecordsCount(long, int, int)
 int getCompanyRecordsCount(long companyId, int status, int scope)
           
 DDLRecord getDDLRecord(long recordId)
          Returns the d d l record with the primary key.
 DDLRecord getDDLRecordByUuidAndCompanyId(String uuid, long companyId)
          Returns the d d l record with the matching UUID and company.
 DDLRecord getDDLRecordByUuidAndGroupId(String uuid, long groupId)
          Returns the d d l record matching the UUID and group.
 List<DDLRecord> getDDLRecords(int start, int end)
          Returns a range of all the d d l records.
 int getDDLRecordsCount()
          Returns the number of d d l records.
 DDLRecordVersion getLatestRecordVersion(long recordId)
           
 Long[] getMinAndMaxCompanyRecordIds(long companyId, int status, int scope)
           
 List<DDLRecord> getMinAndMaxCompanyRecords(long companyId, int status, int scope, long minRecordId, long maxRecordId)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 DDLRecord getRecord(long recordId)
           
 List<DDLRecord> getRecords(long recordSetId)
           
 List<DDLRecord> getRecords(long recordSetId, int status, int start, int end, OrderByComparator orderByComparator)
           
 List<DDLRecord> getRecords(long recordSetId, long userId)
           
 int getRecordsCount(long recordSetId, int status)
           
 DDLRecordVersion getRecordVersion(long recordVersionId)
           
 DDLRecordVersion getRecordVersion(long recordId, String version)
           
 List<DDLRecordVersion> getRecordVersions(long recordId, int start, int end, OrderByComparator orderByComparator)
           
 int getRecordVersionsCount(long recordId)
           
 void revertRecordVersion(long userId, long recordId, String version, ServiceContext serviceContext)
           
 Hits search(SearchContext searchContext)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void updateAsset(long userId, DDLRecord record, DDLRecordVersion recordVersion, long[] assetCategoryIds, String[] assetTagNames, Locale locale)
           
 DDLRecord updateDDLRecord(DDLRecord ddlRecord)
          Updates the d d l record in the database or adds it if it does not yet exist.
 DDLRecord updateRecord(long userId, long recordId, boolean majorVersion, int displayIndex, Fields fields, boolean mergeFields, ServiceContext serviceContext)
           
 DDLRecord updateRecord(long userId, long recordId, int displayIndex, Map<String,Serializable> fieldsMap, boolean mergeFields, ServiceContext serviceContext)
           
 DDLRecord updateStatus(long userId, long recordVersionId, int status, ServiceContext serviceContext)
           
 

Method Detail

addDDLRecord

@Indexable(type=REINDEX)
DDLRecord addDDLRecord(DDLRecord ddlRecord)
                       throws SystemException
Adds the d d l record to the database. Also notifies the appropriate model listeners.

Parameters:
ddlRecord - the d d l record
Returns:
the d d l record that was added
Throws:
SystemException - if a system exception occurred

createDDLRecord

DDLRecord createDDLRecord(long recordId)
Creates a new d d l record with the primary key. Does not add the d d l record to the database.

Parameters:
recordId - the primary key for the new d d l record
Returns:
the new d d l record

deleteDDLRecord

@Indexable(type=DELETE)
DDLRecord deleteDDLRecord(long recordId)
                          throws PortalException,
                                 SystemException
Deletes the d d l record with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
recordId - the primary key of the d d l record
Returns:
the d d l record that was removed
Throws:
PortalException - if a d d l record with the primary key could not be found
SystemException - if a system exception occurred

deleteDDLRecord

@Indexable(type=DELETE)
DDLRecord deleteDDLRecord(DDLRecord ddlRecord)
                          throws SystemException
Deletes the d d l record from the database. Also notifies the appropriate model listeners.

Parameters:
ddlRecord - the d d l record
Returns:
the d d l record that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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 DDLRecordModelImpl. 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
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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 DDLRecordModelImpl. 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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchDDLRecord

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecord fetchDDLRecord(long recordId)
                         throws SystemException
Throws:
SystemException

fetchDDLRecordByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecord fetchDDLRecordByUuidAndCompanyId(String uuid,
                                                                                    long companyId)
                                           throws SystemException
Returns the d d l record with the matching UUID and company.

Parameters:
uuid - the d d l record's UUID
companyId - the primary key of the company
Returns:
the matching d d l record, or null if a matching d d l record could not be found
Throws:
SystemException - if a system exception occurred

fetchDDLRecordByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecord fetchDDLRecordByUuidAndGroupId(String uuid,
                                                                                  long groupId)
                                         throws SystemException
Returns the d d l record matching the UUID and group.

Parameters:
uuid - the d d l record's UUID
groupId - the primary key of the group
Returns:
the matching d d l record, or null if a matching d d l record could not be found
Throws:
SystemException - if a system exception occurred

getDDLRecord

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecord getDDLRecord(long recordId)
                       throws PortalException,
                              SystemException
Returns the d d l record with the primary key.

Parameters:
recordId - the primary key of the d d l record
Returns:
the d d l record
Throws:
PortalException - if a d d l record with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getDDLRecordByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecord getDDLRecordByUuidAndCompanyId(String uuid,
                                                                                  long companyId)
                                         throws PortalException,
                                                SystemException
Returns the d d l record with the matching UUID and company.

Parameters:
uuid - the d d l record's UUID
companyId - the primary key of the company
Returns:
the matching d d l record
Throws:
PortalException - if a matching d d l record could not be found
SystemException - if a system exception occurred

getDDLRecordByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecord getDDLRecordByUuidAndGroupId(String uuid,
                                                                                long groupId)
                                       throws PortalException,
                                              SystemException
Returns the d d l record matching the UUID and group.

Parameters:
uuid - the d d l record's UUID
groupId - the primary key of the group
Returns:
the matching d d l record
Throws:
PortalException - if a matching d d l record could not be found
SystemException - if a system exception occurred

getDDLRecords

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDLRecord> getDDLRecords(int start,
                                                                       int end)
                              throws SystemException
Returns a range of all the d d l records.

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 DDLRecordModelImpl. 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 d d l records
end - the upper bound of the range of d d l records (not inclusive)
Returns:
the range of d d l records
Throws:
SystemException - if a system exception occurred

getDDLRecordsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDDLRecordsCount()
                       throws SystemException
Returns the number of d d l records.

Returns:
the number of d d l records
Throws:
SystemException - if a system exception occurred

updateDDLRecord

@Indexable(type=REINDEX)
DDLRecord updateDDLRecord(DDLRecord ddlRecord)
                          throws SystemException
Updates the d d l record in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
ddlRecord - the d d l record
Returns:
the d d l record that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addRecord

DDLRecord addRecord(long userId,
                    long groupId,
                    long recordSetId,
                    int displayIndex,
                    Fields fields,
                    ServiceContext serviceContext)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

addRecord

DDLRecord addRecord(long userId,
                    long groupId,
                    long recordSetId,
                    int displayIndex,
                    Map<String,Serializable> fieldsMap,
                    ServiceContext serviceContext)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

deleteRecord

void deleteRecord(DDLRecord record)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

deleteRecord

void deleteRecord(long recordId)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

deleteRecordLocale

DDLRecord deleteRecordLocale(long recordId,
                             Locale locale,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

deleteRecords

void deleteRecords(long recordSetId)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

fetchRecord

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecord fetchRecord(long recordId)
                      throws SystemException
Throws:
SystemException

getCompanyRecords

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDLRecord> getCompanyRecords(long companyId,
                                                                           int status,
                                                                           int scope,
                                                                           int start,
                                                                           int end,
                                                                           OrderByComparator orderByComparator)
                                  throws SystemException
Throws:
SystemException

getCompanyRecords

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDLRecord> getCompanyRecords(long companyId,
                                                                           int scope,
                                                                           int start,
                                                                           int end,
                                                                           OrderByComparator orderByComparator)
                                  throws SystemException
Deprecated. As of 6.2.0, replaced by getCompanyRecords(long, int, int, int, int, OrderByComparator)

Throws:
SystemException

getCompanyRecordsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyRecordsCount(long companyId,
                                                                    int scope)
                           throws SystemException
Deprecated. As of 6.2.0, replaced by getCompanyRecordsCount(long, int, int)

Throws:
SystemException

getCompanyRecordsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyRecordsCount(long companyId,
                                                                    int status,
                                                                    int scope)
                           throws SystemException
Throws:
SystemException

getLatestRecordVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecordVersion getLatestRecordVersion(long recordId)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getMinAndMaxCompanyRecordIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Long[] getMinAndMaxCompanyRecordIds(long companyId,
                                                                             int status,
                                                                             int scope)
                                    throws SystemException
Throws:
SystemException

getMinAndMaxCompanyRecords

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDLRecord> getMinAndMaxCompanyRecords(long companyId,
                                                                                    int status,
                                                                                    int scope,
                                                                                    long minRecordId,
                                                                                    long maxRecordId)
                                           throws SystemException
Throws:
SystemException

getRecord

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

getRecords

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDLRecord> getRecords(long recordSetId)
                           throws SystemException
Throws:
SystemException

getRecords

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDLRecord> getRecords(long recordSetId,
                                                                    int status,
                                                                    int start,
                                                                    int end,
                                                                    OrderByComparator orderByComparator)
                           throws SystemException
Throws:
SystemException

getRecords

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDLRecord> getRecords(long recordSetId,
                                                                    long userId)
                           throws SystemException
Throws:
SystemException

getRecordsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRecordsCount(long recordSetId,
                                                             int status)
                    throws SystemException
Throws:
SystemException

getRecordVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecordVersion getRecordVersion(long recordVersionId)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

getRecordVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecordVersion getRecordVersion(long recordId,
                                                                           String version)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

getRecordVersions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDLRecordVersion> getRecordVersions(long recordId,
                                                                                  int start,
                                                                                  int end,
                                                                                  OrderByComparator orderByComparator)
                                         throws SystemException
Throws:
SystemException

getRecordVersionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRecordVersionsCount(long recordId)
                           throws SystemException
Throws:
SystemException

revertRecordVersion

void revertRecordVersion(long userId,
                         long recordId,
                         String version,
                         ServiceContext serviceContext)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(SearchContext searchContext)
            throws SystemException
Throws:
SystemException

updateAsset

void updateAsset(long userId,
                 DDLRecord record,
                 DDLRecordVersion recordVersion,
                 long[] assetCategoryIds,
                 String[] assetTagNames,
                 Locale locale)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

updateRecord

DDLRecord updateRecord(long userId,
                       long recordId,
                       boolean majorVersion,
                       int displayIndex,
                       Fields fields,
                       boolean mergeFields,
                       ServiceContext serviceContext)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

updateRecord

DDLRecord updateRecord(long userId,
                       long recordId,
                       int displayIndex,
                       Map<String,Serializable> fieldsMap,
                       boolean mergeFields,
                       ServiceContext serviceContext)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

updateStatus

DDLRecord updateStatus(long userId,
                       long recordVersionId,
                       int status,
                       ServiceContext serviceContext)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5