Package org.exoplatform.addons.gamification.service.configuration

Interface RuleService

All Known Implementing Classes:

RuleServiceImpl

public interface RuleService

Method Summary

Modifier and Type	Method	Description
RuleDTO	addRule(RuleDTO ruleDTO)	Add Rule to DB
void	deleteRule(Long id)	delete rule with specific id
List<RuleDTO>	findAllRules()	Get all Rules from DB
List<RuleDTO>	findEnabledRulesByEvent(String ruleTitle)	Find enable RuleEntity by title
RuleDTO	findEnableRuleByTitle(String ruleTitle)	Find enable RuleEntity by title
RuleDTO	findRuleByEventAndDomain(String ruleTitle, String domain)	Find a RuleEntity by title
RuleDTO	findRuleById(Long id)	Get RuleEntity by id
RuleDTO	findRuleByTitle(String ruleTitle)	Find a RuleEntity by title
List<RuleDTO>	getActiveRules()	Get all active Rules from DB
List<RuleDTO>	getAllAutomaticRules()	Get all Automatic Rules from DB
List<String>	getAllEvents()	Get all Events from rules
List<RuleDTO>	getAllRulesByDomain(String domain)	Get all Rules by Domain from DB * @param domain : rule's domain param
List<RuleDTO>	getAllRulesWithNullDomain()	Get all Rules by with null DomainDTO from DB
List<String>	getDomainListFromRules()	Get all Domains from Rules from DB
RuleDTO	updateRule(RuleDTO ruleDTO)	Update Rule to DB

Method Detail

findEnableRuleByTitle

RuleDTO findEnableRuleByTitle(String ruleTitle)
                       throws IllegalArgumentException

Find enable RuleEntity by title

Parameters:

ruleTitle - : rule's title param

Returns:

an instance of RuleDTO

Throws:

IllegalArgumentException

findRuleById

RuleDTO findRuleById(Long id)
              throws IllegalArgumentException

Get RuleEntity by id

Parameters:

id - : rule's id param

Returns:

an instance of RuleDTO

Throws:

IllegalArgumentException

findEnabledRulesByEvent

List<RuleDTO> findEnabledRulesByEvent(String ruleTitle)
                               throws IllegalArgumentException

Find enable RuleEntity by title

Parameters:

ruleTitle - : rule's title param

Returns:

an instance of RuleDTO

Throws:

IllegalArgumentException

findRuleByTitle

RuleDTO findRuleByTitle(String ruleTitle)
                 throws IllegalArgumentException

Find a RuleEntity by title

Parameters:

ruleTitle - : rule's title param

Returns:

an instance of RuleDTO

Throws:

IllegalArgumentException

findRuleByEventAndDomain

RuleDTO findRuleByEventAndDomain(String ruleTitle,
                                 String domain)
                          throws IllegalArgumentException

Find a RuleEntity by title

Parameters:

ruleTitle - : rule's title param

domain - : rule's domain param

Returns:

an instance of RuleDTO

Throws:

IllegalArgumentException

getAllAutomaticRules

List<RuleDTO> getAllAutomaticRules()

Get all Automatic Rules from DB

Returns:

RuleDTO list

findAllRules

List<RuleDTO> findAllRules()

Get all Rules from DB

Returns:

RuleDTO list

getActiveRules

List<RuleDTO> getActiveRules()

Get all active Rules from DB

Returns:

RuleDTO list

getAllRulesByDomain

List<RuleDTO> getAllRulesByDomain(String domain)
                           throws IllegalArgumentException

Get all Rules by Domain from DB * @param domain : rule's domain param

Returns:

RuleDTO list

Throws:

IllegalArgumentException

getAllRulesWithNullDomain

List<RuleDTO> getAllRulesWithNullDomain()

Get all Rules by with null DomainDTO from DB

Returns:

RuleDTO list

getAllEvents

List<String> getAllEvents()

Get all Events from rules

Returns:

RuleDTO list

getDomainListFromRules

List<String> getDomainListFromRules()

Get all Domains from Rules from DB

Returns:

String list

deleteRule

void deleteRule(Long id)
         throws Exception

delete rule with specific id

Throws:

Exception

addRule

RuleDTO addRule(RuleDTO ruleDTO)
         throws Exception

Add Rule to DB

Parameters:

ruleDTO - : an object of type RuleDTO

Returns:

RuleDTO object

Throws:

Exception

updateRule

RuleDTO updateRule(RuleDTO ruleDTO)
            throws Exception

Update Rule to DB

Parameters:

ruleDTO - : an object of type RuleDTO

Returns:

RuleDTO object

Throws:

Exception