Package org.openiam.srvc.selfregistration

Interface SelfRegistrationWorkflowWebService

All Known Implementing Classes:

SelfRegistrationWorkflowWebServiceImpl

public interface SelfRegistrationWorkflowWebService

Author:

zaporozhec The web service provides and API to manage Self Registration flow entities.

Method Summary

Modifier and Type	Method	Description
IncompleteSelfRegistrationDto	applyStep(SelfRegistrationDataRequest request)	After user save information on UI we MUST send this information to background to validate and manage next actions.
Response	deleteStep(String id)	is used to delete SelfRegistrationStepDto
Response	deleteWorkflow(String id)	is used to delete SelfRegistrationWorkflowDto
SelfRegistrationStepListResponse	findSteps(SelfRegistrationStepSearchBean searchBean, int from, int size)	The general method to search for SelfRegistrationStepDto objects
SelfRegistrationWorkflowListResponse	findWorkflows(SelfRegistrationWorkflowSearchBean searchBean, int from, int size)	The general method to search for SelfRegistrationWorkflowDto objects
IncompleteSelfRegistrationDto	getCurrentStep(String sessionId)	Get current step for selfregistration flow by user sessionId.
SelfRegistrationWorkflowTree	getDashboard(String id)	Service is used to get a Self Registration workflow chain.
List<KeyNameDTO>	getLinkedWorkflows(String id)	Service is used to get a Self Registration workflow chains that contains given Workflow step (by Id) .
SelfRegistrationStepDto	getStep(String id)	is used to get SelfRegistrationWorkflowDto
SelfRegistrationWorkflowDto	getWorkflow(String id)	is used to get SelfRegistrationWorkflowDto
SelfRegistrationStepDto	newStep(NewStepBean dto)	Method is used to create a new Self Registration Step SelfRegistrationStepDto.
SelfRegistrationStepDtoResponse	saveStep(SelfRegistrationStepDto dto)	is used to save SelfRegistrationStepDto
SelfRegistrationWorkflowDtoResponse	saveWorkflow(SelfRegistrationWorkflowDto dto)	is used to save SelfRegistrationWorkflowDto

Method Detail

saveStep

SelfRegistrationStepDtoResponse saveStep(SelfRegistrationStepDto dto)

is used to save SelfRegistrationStepDto

Parameters:

dto - - the bean to be saved

Returns:

- return #dto after save. if this was new dto, it will be filled by ID

saveWorkflow

SelfRegistrationWorkflowDtoResponse saveWorkflow(SelfRegistrationWorkflowDto dto)

is used to save SelfRegistrationWorkflowDto

Parameters:

dto - - the bean to be saved

Returns:

- return #dto after save. if this was new dto, it will be filled by ID

newStep

SelfRegistrationStepDto newStep(NewStepBean dto)

Method is used to create a new Self Registration Step SelfRegistrationStepDto. during creation new Page Template will be created or will be used one that is defined in NewStepBean#getTemplateId()

New Target will be created with Action BusinessRuleActionTypeEnum.TRIGGER_CREATE_WITH_APPROVAL by default to trigger an approval process for new user. Could be changed after step creation.

Parameters:

dto - - NewStepBean contains required data for creation a new Step.

Returns:

SelfRegistrationStepDto with all related information

deleteStep

Response deleteStep(String id)

is used to delete SelfRegistrationStepDto

Parameters:

id - - the identification of SelfRegistrationStepDto to be deleted

Returns:

- Response with Response#getStatus() as a ResponseStatus.SUCCESS in case the entity has been deleted and ResponseStatus.FAILURE otherwise

deleteWorkflow

Response deleteWorkflow(String id)

is used to delete SelfRegistrationWorkflowDto

Parameters:

id - - the identification of SelfRegistrationWorkflowDto to be deleted

Returns:

- Response with Response#getStatus() as a ResponseStatus.SUCCESS in case the entity has been deleted and ResponseStatus.FAILURE otherwise

getStep

SelfRegistrationStepDto getStep(String id)

is used to get SelfRegistrationWorkflowDto

Parameters:

id - - the identification of SelfRegistrationStepDto to get

Returns:

- SelfRegistrationStepDtoResponse with SelfRegistrationStepDtoResponse#getValue() as a SelfRegistrationStepDto in case the entity has been found and null otherwise

getWorkflow

SelfRegistrationWorkflowDto getWorkflow(String id)

is used to get SelfRegistrationWorkflowDto

Parameters:

id - - the identification of SelfRegistrationWorkflowDto to get

Returns:

- SelfRegistrationWorkflowDtoResponse with SelfRegistrationWorkflowDtoResponse#getValue() as a SelfRegistrationWorkflowDto in case the entity has been found and null otherwise

findWorkflows

SelfRegistrationWorkflowListResponse findWorkflows(SelfRegistrationWorkflowSearchBean searchBean,
                                                   int from,
                                                   int size)

The general method to search for SelfRegistrationWorkflowDto objects

Parameters:

searchBean - - SelfRegistrationWorkflowSearchBean with filter data

from - - very 1st result number

size - - number of results to be listed

Returns:

- SelfRegistrationWorkflowListResponse that contains a list of SelfRegistrationWorkflowDto in SelfRegistrationWorkflowListResponse#getList()

findSteps

SelfRegistrationStepListResponse findSteps(SelfRegistrationStepSearchBean searchBean,
                                           int from,
                                           int size)

The general method to search for SelfRegistrationStepDto objects

Parameters:

searchBean - - SelfRegistrationStepSearchBean with filter data

from - - very 1st result number

size - - number of results to be listed

Returns:

- SelfRegistrationStepListResponse that contains a list of SelfRegistrationStepDto in SelfRegistrationStepListResponse#getList()

getDashboard

SelfRegistrationWorkflowTree getDashboard(String id)

Service is used to get a Self Registration workflow chain. Chain is presented by Nodes SelfRegistrationWorkflowTreeNode

Parameters:

id - - id of the Self Registration workflow that required to be displayed

Returns:

SelfRegistrationWorkflowTree with data. The value might be null in case - no any steps are in the workflow.

getLinkedWorkflows

List<KeyNameDTO> getLinkedWorkflows(String id)

Service is used to get a Self Registration workflow chains that contains given Workflow step (by Id) . Chain is presented by Nodes org.openiam.idm.srvc.selfregistration.dto.KeyNameDTO

Parameters:

id - - id of the Self Registration Step that required to be checked

Returns:

KeyNameDTO list with data. The value might be null in case - no any steps are in the workflow.

getCurrentStep

IncompleteSelfRegistrationDto getCurrentStep(String sessionId)

Get current step for selfregistration flow by user sessionId. SessionId must not be null, if this is new flow, create a session and get id from UI.

Parameters:

sessionId - - id of current user session

Returns:

IncompleteSelfRegistrationDto - response with data required for step render on UI.

applyStep

IncompleteSelfRegistrationDto applyStep(SelfRegistrationDataRequest request)

After user save information on UI we MUST send this information to background to validate and manage next actions. if IncompleteSelfRegistrationDto#isCompleted() is TRUE than selfregistartion is finished and you must check IncompleteSelfRegistrationDto#isWithApproval(), otherwise you will receive IncompleteSelfRegistrationDto#getStepId() and IncompleteSelfRegistrationDto#getStep(). IncompleteSelfRegistrationDto#isWithApproval() is TRUE than the request was created to approve by configred approver, otherwise we save and provision user as a new User.

Parameters:

request - - SelfRegistrationDataRequest - information filled by user on GUI

Returns:

SelfRegistrationDataRequest - the information about next step of about the fact of flow completion.