Package org.openiam.srvc.am

Interface BusinessRuleWebService

All Known Implementing Classes:

BusinessRuleWebServiceImpl

public interface BusinessRuleWebService

Web service is used to control and managed Business rules and related objects (like Targets)

Method Summary

Modifier and Type	Method	Description
Response	deleteBusinessRule(String id)
Response	deleteTarget(String id)
BusinessRuleEvaluationResponse	evaluateUser(BusinessRuleCrudRequest evaluationCrudServiceRequest)
BusinessRuleDtoListResponse	findBeans(BusinessRuleSearchBean searchBean, int from, int size)
BusinessRuleTargetListDtoResponse	findTarget(BusinessRuleTargetSearchBean searchBean, int from, int size)
BusinessRuleUserRecalculationListResponse	findUsersToBeRecalculated(String name, int from, int size)	Method is used to get list of Preview users, it's a lit of users that affected by chages in business rules.
BusinessRuleDto	getBusinessRule(String id)
BrTargetDto	getTarget(String id)
Response	performRecalculation()	Will perform the recalculation (provisioning of users) based on the business rules with pending statuses.
Response	performReview()	action to generate a list of users that are impacted by business rules changes.
BusinessRuleDtoResponse	saveBusinessRule(BusinessRuleDto businessRule)	Method is user to save (add / Update) Business rule.
BrTargetDto	saveTarget(BrTargetDto target)	Method is user to save (add / Update) target.
Response	validate(BrConditionDto condition)	Method is used to validate logic of the the condition.

Method Detail

saveTarget

BrTargetDto saveTarget(BrTargetDto target)

Method is user to save (add / Update) target. This action will change BusinessRuleDto#getStatus() to BusinessRuleStatusEnum.ON_MODIFY value, so the business rule will be in the list of rules that we should check agains all users.

Parameters:

target - target BrConditionDto to be saved

Returns:

- return BrConditionDto dto after save from the DB

getTarget

BrTargetDto getTarget(String id)

Parameters:

id - - is of the target that need to get.

Returns:

- null if no entity with the provided id otherwise return BrTargetDto

deleteTarget

Response deleteTarget(String id)

Parameters:

id - - is of the target that need to be deleted.

Returns:

- Response#getStatus() with ResponseStatus.FAILURE if target is used in any business rules or will be problems with database. Otherwise it will return Response#getStatus() with ResponseStatus.SUCCESS value

saveBusinessRule

BusinessRuleDtoResponse saveBusinessRule(BusinessRuleDto businessRule)

Method is user to save (add / Update) Business rule. This action will change BusinessRuleDto#getStatus() to: - BusinessRuleStatusEnum.ON_MODIFY if business rule was changed or status was changed from BusinessRuleStatusEnum.INACTIVE to BusinessRuleStatusEnum.ACTIVE - BusinessRuleStatusEnum.ON_DEACTIVATE if business rule status was changed from BusinessRuleStatusEnum.ACTIVE to BusinessRuleStatusEnum.INACTIVE - BusinessRuleStatusEnum.ON_DELETE if business rule going to be deleted of rules that we should check against all users.

Parameters:

businessRule - - business rule BrConditionDto to be saved

Returns:

- return BusinessRuleDtoResponse response after save from the DB

getBusinessRule

BusinessRuleDto getBusinessRule(String id)

deleteBusinessRule

Response deleteBusinessRule(String id)

findBeans

BusinessRuleDtoListResponse findBeans(BusinessRuleSearchBean searchBean,
                                      int from,
                                      int size)

findTarget

BusinessRuleTargetListDtoResponse findTarget(BusinessRuleTargetSearchBean searchBean,
                                             int from,
                                             int size)

validate

Response validate(BrConditionDto condition)

Method is used to validate logic of the the condition.

Parameters:

condition - - the condition to be checked

Returns:

findUsersToBeRecalculated

BusinessRuleUserRecalculationListResponse findUsersToBeRecalculated(String name,
                                                                    int from,
                                                                    int size)

Method is used to get list of Preview users, it's a lit of users that affected by chages in business rules.

Parameters:

name - - the user name for search

from - - from (zero based) start of result

size - - size of result page

Returns:

- BusinessRuleUserRecalculationListResponse with explanations.

performRecalculation

Response performRecalculation()

Will perform the recalculation (provisioning of users) based on the business rules with pending statuses.

Returns:

- success, due to it's async, don't expect here any business logic errors.

performReview

Response performReview()

action to generate a list of users that are impacted by business rules changes.

Returns:

- success, due to it's async, don't expect here any business logic errors.

evaluateUser

BusinessRuleEvaluationResponse evaluateUser(BusinessRuleCrudRequest evaluationCrudServiceRequest)