Liferay 6.2-ce-ga5

com.liferay.portlet.dynamicdatalists.service
Interface DDLRecordSetLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
DDLRecordSetLocalServiceWrapper

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

Provides the local service interface for DDLRecordSet. 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:
DDLRecordSetLocalServiceUtil, com.liferay.portlet.dynamicdatalists.service.base.DDLRecordSetLocalServiceBaseImpl, com.liferay.portlet.dynamicdatalists.service.impl.DDLRecordSetLocalServiceImpl

Method Summary
 DDLRecordSet addDDLRecordSet(DDLRecordSet ddlRecordSet)
          Adds the d d l record set to the database.
 DDLRecordSet addRecordSet(long userId, long groupId, long ddmStructureId, String recordSetKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int minDisplayRows, int scope, ServiceContext serviceContext)
           
 void addRecordSetResources(DDLRecordSet recordSet, boolean addGroupPermissions, boolean addGuestPermissions)
           
 void addRecordSetResources(DDLRecordSet recordSet, String[] groupPermissions, String[] guestPermissions)
           
 DDLRecordSet createDDLRecordSet(long recordSetId)
          Creates a new d d l record set with the primary key.
 DDLRecordSet deleteDDLRecordSet(DDLRecordSet ddlRecordSet)
          Deletes the d d l record set from the database.
 DDLRecordSet deleteDDLRecordSet(long recordSetId)
          Deletes the d d l record set with the primary key from the database.
 void deleteRecordSet(DDLRecordSet recordSet)
           
 void deleteRecordSet(long recordSetId)
           
 void deleteRecordSet(long groupId, String recordSetKey)
           
 void deleteRecordSets(long groupId)
           
 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.
 DDLRecordSet fetchDDLRecordSet(long recordSetId)
           
 DDLRecordSet fetchDDLRecordSetByUuidAndCompanyId(String uuid, long companyId)
          Returns the d d l record set with the matching UUID and company.
 DDLRecordSet fetchDDLRecordSetByUuidAndGroupId(String uuid, long groupId)
          Returns the d d l record set matching the UUID and group.
 DDLRecordSet fetchRecordSet(long recordSetId)
           
 DDLRecordSet fetchRecordSet(long groupId, String recordSetKey)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 DDLRecordSet getDDLRecordSet(long recordSetId)
          Returns the d d l record set with the primary key.
 DDLRecordSet getDDLRecordSetByUuidAndCompanyId(String uuid, long companyId)
          Returns the d d l record set with the matching UUID and company.
 DDLRecordSet getDDLRecordSetByUuidAndGroupId(String uuid, long groupId)
          Returns the d d l record set matching the UUID and group.
 List<DDLRecordSet> getDDLRecordSets(int start, int end)
          Returns a range of all the d d l record sets.
 int getDDLRecordSetsCount()
          Returns the number of d d l record sets.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 DDLRecordSet getRecordSet(long recordSetId)
           
 DDLRecordSet getRecordSet(long groupId, String recordSetKey)
           
 List<DDLRecordSet> getRecordSets(long groupId)
           
 int getRecordSetsCount(long groupId)
           
 List<DDLRecordSet> search(long companyId, long groupId, String keywords, int scope, int start, int end, OrderByComparator orderByComparator)
           
 List<DDLRecordSet> search(long companyId, long groupId, String name, String description, int scope, boolean andOperator, int start, int end, OrderByComparator orderByComparator)
           
 int searchCount(long companyId, long groupId, String keywords, int scope)
           
 int searchCount(long companyId, long groupId, String name, String description, int scope, boolean andOperator)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 DDLRecordSet updateDDLRecordSet(DDLRecordSet ddlRecordSet)
          Updates the d d l record set in the database or adds it if it does not yet exist.
 DDLRecordSet updateMinDisplayRows(long recordSetId, int minDisplayRows, ServiceContext serviceContext)
           
 DDLRecordSet updateRecordSet(long recordSetId, long ddmStructureId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int minDisplayRows, ServiceContext serviceContext)
           
 DDLRecordSet updateRecordSet(long groupId, long ddmStructureId, String recordSetKey, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int minDisplayRows, ServiceContext serviceContext)
           
 

Method Detail

addDDLRecordSet

@Indexable(type=REINDEX)
DDLRecordSet addDDLRecordSet(DDLRecordSet ddlRecordSet)
                             throws SystemException
Adds the d d l record set to the database. Also notifies the appropriate model listeners.

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

createDDLRecordSet

DDLRecordSet createDDLRecordSet(long recordSetId)
Creates a new d d l record set with the primary key. Does not add the d d l record set to the database.

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

deleteDDLRecordSet

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

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

deleteDDLRecordSet

@Indexable(type=DELETE)
DDLRecordSet deleteDDLRecordSet(DDLRecordSet ddlRecordSet)
                                throws SystemException
Deletes the d d l record set from the database. Also notifies the appropriate model listeners.

Parameters:
ddlRecordSet - the d d l record set
Returns:
the d d l record set 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 DDLRecordSetModelImpl. 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 DDLRecordSetModelImpl. 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

fetchDDLRecordSet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecordSet fetchDDLRecordSet(long recordSetId)
                               throws SystemException
Throws:
SystemException

fetchDDLRecordSetByUuidAndCompanyId

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

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

fetchDDLRecordSetByUuidAndGroupId

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

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

getDDLRecordSet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecordSet getDDLRecordSet(long recordSetId)
                             throws PortalException,
                                    SystemException
Returns the d d l record set with the primary key.

Parameters:
recordSetId - the primary key of the d d l record set
Returns:
the d d l record set
Throws:
PortalException - if a d d l record set 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

getDDLRecordSetByUuidAndCompanyId

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

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

getDDLRecordSetByUuidAndGroupId

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

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

getDDLRecordSets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDLRecordSet> getDDLRecordSets(int start,
                                                                             int end)
                                    throws SystemException
Returns a range of all the d d l record sets.

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

getDDLRecordSetsCount

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

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

updateDDLRecordSet

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

Parameters:
ddlRecordSet - the d d l record set
Returns:
the d d l record set 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

addRecordSet

DDLRecordSet addRecordSet(long userId,
                          long groupId,
                          long ddmStructureId,
                          String recordSetKey,
                          Map<Locale,String> nameMap,
                          Map<Locale,String> descriptionMap,
                          int minDisplayRows,
                          int scope,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

addRecordSetResources

void addRecordSetResources(DDLRecordSet recordSet,
                           boolean addGroupPermissions,
                           boolean addGuestPermissions)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

addRecordSetResources

void addRecordSetResources(DDLRecordSet recordSet,
                           String[] groupPermissions,
                           String[] guestPermissions)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

deleteRecordSet

@SystemEvent(action=1,
             type=1)
void deleteRecordSet(DDLRecordSet recordSet)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

deleteRecordSet

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

deleteRecordSet

void deleteRecordSet(long groupId,
                     String recordSetKey)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

deleteRecordSets

void deleteRecordSets(long groupId)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

fetchRecordSet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecordSet fetchRecordSet(long recordSetId)
                            throws SystemException
Throws:
SystemException

fetchRecordSet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecordSet fetchRecordSet(long groupId,
                                                                     String recordSetKey)
                            throws SystemException
Throws:
SystemException

getRecordSet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecordSet getRecordSet(long recordSetId)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getRecordSet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DDLRecordSet getRecordSet(long groupId,
                                                                   String recordSetKey)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getRecordSets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDLRecordSet> getRecordSets(long groupId)
                                 throws SystemException
Throws:
SystemException

getRecordSetsCount

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

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDLRecordSet> search(long companyId,
                                                                   long groupId,
                                                                   String keywords,
                                                                   int scope,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator orderByComparator)
                          throws SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DDLRecordSet> search(long companyId,
                                                                   long groupId,
                                                                   String name,
                                                                   String description,
                                                                   int scope,
                                                                   boolean andOperator,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator orderByComparator)
                          throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         long groupId,
                                                         String keywords,
                                                         int scope)
                throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         long groupId,
                                                         String name,
                                                         String description,
                                                         int scope,
                                                         boolean andOperator)
                throws SystemException
Throws:
SystemException

updateMinDisplayRows

DDLRecordSet updateMinDisplayRows(long recordSetId,
                                  int minDisplayRows,
                                  ServiceContext serviceContext)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

updateRecordSet

DDLRecordSet updateRecordSet(long recordSetId,
                             long ddmStructureId,
                             Map<Locale,String> nameMap,
                             Map<Locale,String> descriptionMap,
                             int minDisplayRows,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

updateRecordSet

DDLRecordSet updateRecordSet(long groupId,
                             long ddmStructureId,
                             String recordSetKey,
                             Map<Locale,String> nameMap,
                             Map<Locale,String> descriptionMap,
                             int minDisplayRows,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5