Liferay 6.2-ce-ga5

com.liferay.portlet.mobiledevicerules.service
Interface MDRRuleLocalService

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

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

Provides the local service interface for MDRRule. 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:
MDRRuleLocalServiceUtil, com.liferay.portlet.mobiledevicerules.service.base.MDRRuleLocalServiceBaseImpl, com.liferay.portlet.mobiledevicerules.service.impl.MDRRuleLocalServiceImpl

Method Summary
 MDRRule addMDRRule(MDRRule mdrRule)
          Adds the m d r rule to the database.
 MDRRule addRule(long ruleGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String typeSettings, ServiceContext serviceContext)
           
 MDRRule addRule(long ruleGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, UnicodeProperties typeSettingsProperties, ServiceContext serviceContext)
           
 MDRRule copyRule(long ruleId, long ruleGroupId, ServiceContext serviceContext)
           
 MDRRule copyRule(MDRRule rule, long ruleGroupId, ServiceContext serviceContext)
           
 MDRRule createMDRRule(long ruleId)
          Creates a new m d r rule with the primary key.
 MDRRule deleteMDRRule(long ruleId)
          Deletes the m d r rule with the primary key from the database.
 MDRRule deleteMDRRule(MDRRule mdrRule)
          Deletes the m d r rule from the database.
 void deleteRule(long ruleId)
           
 void deleteRule(MDRRule rule)
           
 void deleteRules(long ruleGroupId)
           
 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.
 MDRRule fetchMDRRule(long ruleId)
           
 MDRRule fetchMDRRuleByUuidAndCompanyId(String uuid, long companyId)
          Returns the m d r rule with the matching UUID and company.
 MDRRule fetchMDRRuleByUuidAndGroupId(String uuid, long groupId)
          Returns the m d r rule matching the UUID and group.
 MDRRule fetchRule(long ruleId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 MDRRule getMDRRule(long ruleId)
          Returns the m d r rule with the primary key.
 MDRRule getMDRRuleByUuidAndCompanyId(String uuid, long companyId)
          Returns the m d r rule with the matching UUID and company.
 MDRRule getMDRRuleByUuidAndGroupId(String uuid, long groupId)
          Returns the m d r rule matching the UUID and group.
 List<MDRRule> getMDRRules(int start, int end)
          Returns a range of all the m d r rules.
 int getMDRRulesCount()
          Returns the number of m d r rules.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 MDRRule getRule(long ruleId)
           
 List<MDRRule> getRules(long ruleGroupId)
           
 List<MDRRule> getRules(long ruleGroupId, int start, int end)
           
 int getRulesCount(long ruleGroupId)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 MDRRule updateMDRRule(MDRRule mdrRule)
          Updates the m d r rule in the database or adds it if it does not yet exist.
 MDRRule updateRule(long ruleId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, String typeSettings, ServiceContext serviceContext)
           
 MDRRule updateRule(long ruleId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, String type, UnicodeProperties typeSettingsProperties, ServiceContext serviceContext)
           
 

Method Detail

addMDRRule

@Indexable(type=REINDEX)
MDRRule addMDRRule(MDRRule mdrRule)
                   throws SystemException
Adds the m d r rule to the database. Also notifies the appropriate model listeners.

Parameters:
mdrRule - the m d r rule
Returns:
the m d r rule that was added
Throws:
SystemException - if a system exception occurred

createMDRRule

MDRRule createMDRRule(long ruleId)
Creates a new m d r rule with the primary key. Does not add the m d r rule to the database.

Parameters:
ruleId - the primary key for the new m d r rule
Returns:
the new m d r rule

deleteMDRRule

@Indexable(type=DELETE)
MDRRule deleteMDRRule(long ruleId)
                      throws PortalException,
                             SystemException
Deletes the m d r rule with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
ruleId - the primary key of the m d r rule
Returns:
the m d r rule that was removed
Throws:
PortalException - if a m d r rule with the primary key could not be found
SystemException - if a system exception occurred

deleteMDRRule

@Indexable(type=DELETE)
MDRRule deleteMDRRule(MDRRule mdrRule)
                      throws SystemException
Deletes the m d r rule from the database. Also notifies the appropriate model listeners.

Parameters:
mdrRule - the m d r rule
Returns:
the m d r rule 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 MDRRuleModelImpl. 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 MDRRuleModelImpl. 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

fetchMDRRule

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MDRRule fetchMDRRule(long ruleId)
                     throws SystemException
Throws:
SystemException

fetchMDRRuleByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MDRRule fetchMDRRuleByUuidAndCompanyId(String uuid,
                                                                                long companyId)
                                       throws SystemException
Returns the m d r rule with the matching UUID and company.

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

fetchMDRRuleByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MDRRule fetchMDRRuleByUuidAndGroupId(String uuid,
                                                                              long groupId)
                                     throws SystemException
Returns the m d r rule matching the UUID and group.

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

getMDRRule

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MDRRule getMDRRule(long ruleId)
                   throws PortalException,
                          SystemException
Returns the m d r rule with the primary key.

Parameters:
ruleId - the primary key of the m d r rule
Returns:
the m d r rule
Throws:
PortalException - if a m d r rule 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

getMDRRuleByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MDRRule getMDRRuleByUuidAndCompanyId(String uuid,
                                                                              long companyId)
                                     throws PortalException,
                                            SystemException
Returns the m d r rule with the matching UUID and company.

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

getMDRRuleByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MDRRule getMDRRuleByUuidAndGroupId(String uuid,
                                                                            long groupId)
                                   throws PortalException,
                                          SystemException
Returns the m d r rule matching the UUID and group.

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

getMDRRules

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MDRRule> getMDRRules(int start,
                                                                   int end)
                          throws SystemException
Returns a range of all the m d r rules.

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

getMDRRulesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getMDRRulesCount()
                     throws SystemException
Returns the number of m d r rules.

Returns:
the number of m d r rules
Throws:
SystemException - if a system exception occurred

updateMDRRule

@Indexable(type=REINDEX)
MDRRule updateMDRRule(MDRRule mdrRule)
                      throws SystemException
Updates the m d r rule in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
mdrRule - the m d r rule
Returns:
the m d r rule 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

addRule

MDRRule addRule(long ruleGroupId,
                Map<Locale,String> nameMap,
                Map<Locale,String> descriptionMap,
                String type,
                String typeSettings,
                ServiceContext serviceContext)
                throws PortalException,
                       SystemException
Throws:
PortalException
SystemException

addRule

MDRRule addRule(long ruleGroupId,
                Map<Locale,String> nameMap,
                Map<Locale,String> descriptionMap,
                String type,
                UnicodeProperties typeSettingsProperties,
                ServiceContext serviceContext)
                throws PortalException,
                       SystemException
Throws:
PortalException
SystemException

copyRule

MDRRule copyRule(long ruleId,
                 long ruleGroupId,
                 ServiceContext serviceContext)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

copyRule

MDRRule copyRule(MDRRule rule,
                 long ruleGroupId,
                 ServiceContext serviceContext)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

deleteRule

void deleteRule(long ruleId)
                throws SystemException
Throws:
SystemException

deleteRule

@SystemEvent(type=1)
void deleteRule(MDRRule rule)
                throws SystemException
Throws:
SystemException

deleteRules

void deleteRules(long ruleGroupId)
                 throws SystemException
Throws:
SystemException

fetchRule

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MDRRule fetchRule(long ruleId)
                  throws SystemException
Throws:
SystemException

getRule

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MDRRule getRule(long ruleId)
                throws PortalException,
                       SystemException
Throws:
PortalException
SystemException

getRules

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MDRRule> getRules(long ruleGroupId)
                       throws SystemException
Throws:
SystemException

getRules

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MDRRule> getRules(long ruleGroupId,
                                                                int start,
                                                                int end)
                       throws SystemException
Throws:
SystemException

getRulesCount

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

updateRule

MDRRule updateRule(long ruleId,
                   Map<Locale,String> nameMap,
                   Map<Locale,String> descriptionMap,
                   String type,
                   String typeSettings,
                   ServiceContext serviceContext)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

updateRule

MDRRule updateRule(long ruleId,
                   Map<Locale,String> nameMap,
                   Map<Locale,String> descriptionMap,
                   String type,
                   UnicodeProperties typeSettingsProperties,
                   ServiceContext serviceContext)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

Liferay 6.2-ce-ga5