Liferay 6.2-ce-ga5

com.liferay.portlet.dynamicdatalists.service
Class DDLRecordLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.dynamicdatalists.service.DDLRecordLocalServiceUtil

@ProviderType
public class DDLRecordLocalServiceUtil
extends Object

Provides the local service utility for DDLRecord. This utility wraps com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordLocalServiceImpl and is the primary 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.

See Also:
DDLRecordLocalService, com.liferay.portlet.dynamicdatalists.service.base.DDLRecordLocalServiceBaseImpl, com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordLocalServiceImpl

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

Constructor Detail

DDLRecordLocalServiceUtil

public DDLRecordLocalServiceUtil()
Method Detail

addDDLRecord

public static 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

public static 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

public static 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

public static 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

public static DynamicQuery dynamicQuery()

dynamicQuery

public static 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

public static 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

public static 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

public static 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

public static 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

public static DDLRecord fetchDDLRecord(long recordId)
                                throws SystemException
Throws:
SystemException

fetchDDLRecordByUuidAndCompanyId

public static 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

public static 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

public static 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

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getDDLRecordByUuidAndCompanyId

public static 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

public static 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

public static 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

public static 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

public static 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

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addRecord

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

addRecord

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

deleteRecord

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

deleteRecord

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

deleteRecordLocale

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

deleteRecords

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

fetchRecord

public static DDLRecord fetchRecord(long recordId)
                             throws SystemException
Throws:
SystemException

getCompanyRecords

public static List<DDLRecord> getCompanyRecords(long companyId,
                                                int status,
                                                int scope,
                                                int start,
                                                int end,
                                                OrderByComparator orderByComparator)
                                         throws SystemException
Throws:
SystemException

getCompanyRecords

public static 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

public static int getCompanyRecordsCount(long companyId,
                                         int scope)
                                  throws SystemException
Deprecated. As of 6.2.0, replaced by getCompanyRecordsCount(long, int, int)

Throws:
SystemException

getCompanyRecordsCount

public static int getCompanyRecordsCount(long companyId,
                                         int status,
                                         int scope)
                                  throws SystemException
Throws:
SystemException

getLatestRecordVersion

public static DDLRecordVersion getLatestRecordVersion(long recordId)
                                               throws PortalException,
                                                      SystemException
Throws:
PortalException
SystemException

getMinAndMaxCompanyRecordIds

public static Long[] getMinAndMaxCompanyRecordIds(long companyId,
                                                  int status,
                                                  int scope)
                                           throws SystemException
Throws:
SystemException

getMinAndMaxCompanyRecords

public static List<DDLRecord> getMinAndMaxCompanyRecords(long companyId,
                                                         int status,
                                                         int scope,
                                                         long minRecordId,
                                                         long maxRecordId)
                                                  throws SystemException
Throws:
SystemException

getRecord

public static DDLRecord getRecord(long recordId)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

getRecords

public static List<DDLRecord> getRecords(long recordSetId)
                                  throws SystemException
Throws:
SystemException

getRecords

public static List<DDLRecord> getRecords(long recordSetId,
                                         int status,
                                         int start,
                                         int end,
                                         OrderByComparator orderByComparator)
                                  throws SystemException
Throws:
SystemException

getRecords

public static List<DDLRecord> getRecords(long recordSetId,
                                         long userId)
                                  throws SystemException
Throws:
SystemException

getRecordsCount

public static int getRecordsCount(long recordSetId,
                                  int status)
                           throws SystemException
Throws:
SystemException

getRecordVersion

public static DDLRecordVersion getRecordVersion(long recordVersionId)
                                         throws PortalException,
                                                SystemException
Throws:
PortalException
SystemException

getRecordVersion

public static DDLRecordVersion getRecordVersion(long recordId,
                                                String version)
                                         throws PortalException,
                                                SystemException
Throws:
PortalException
SystemException

getRecordVersions

public static List<DDLRecordVersion> getRecordVersions(long recordId,
                                                       int start,
                                                       int end,
                                                       OrderByComparator orderByComparator)
                                                throws SystemException
Throws:
SystemException

getRecordVersionsCount

public static int getRecordVersionsCount(long recordId)
                                  throws SystemException
Throws:
SystemException

revertRecordVersion

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

search

public static Hits search(SearchContext searchContext)
                   throws SystemException
Throws:
SystemException

updateAsset

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

updateRecord

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

updateRecord

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

updateStatus

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

getService

public static DDLRecordLocalService getService()

setService

public void setService(DDLRecordLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5