Package de.aeb.xnsg.foundation.bf

Interface IInternalProvisioningBF

@BusinessFacade
public interface IInternalProvisioningBF

Internal API for provisioning clients from a template.

Method Summary

Modifier and Type	Method	Description
CreateClientFromTemplateResponseDTO	createClientFromTemplate(CreateClientFromTemplateRequestDTO requestDTO)	Creates a new client by duplicating it from a given template client.
GetClientFeaturesResponseDTO	getClientFeatures(GetClientFeaturesRequestDTO getClientFeaturesRequestDTO)	Retrieve all client features for a given client.
GetCreateClientFromTemplateStatusResponseDTO	getCreateClientFromTemplateStatus(GetCreateClientFromTemplateStatusRequestDTO requestDTO)	Retrieve the status of an ongoing or completed client duplication process started by createClientFromTemplate(CreateClientFromTemplateRequestDTO).
SetClientFeaturesResponseDTO	setClientFeatures(SetClientFeaturesRequestDTO setClientFeaturesRequestDTO)	Update the client features for a given client.

Method Details

createClientFromTemplate

CreateClientFromTemplateResponseDTO createClientFromTemplate(CreateClientFromTemplateRequestDTO requestDTO)

Creates a new client by duplicating it from a given template client. Start the process here and check its progress using getCreateClientFromTemplateStatus(GetCreateClientFromTemplateStatusRequestDTO)

Parameters:

requestDTO - contains the parameters for the duplication

Returns:

the processId of the started duplication process, which is used to check its progress

getCreateClientFromTemplateStatus

GetCreateClientFromTemplateStatusResponseDTO getCreateClientFromTemplateStatus(GetCreateClientFromTemplateStatusRequestDTO requestDTO)

Retrieve the status of an ongoing or completed client duplication process started by createClientFromTemplate(CreateClientFromTemplateRequestDTO).

Parameters:

requestDTO - the processId obtained by createClientFromTemplate(CreateClientFromTemplateRequestDTO)

Returns:

information about the current status, such as progress or potential errors.

getClientFeatures

GetClientFeaturesResponseDTO getClientFeatures(GetClientFeaturesRequestDTO getClientFeaturesRequestDTO)

Retrieve all client features for a given client.

Parameters:

getClientFeaturesRequestDTO - requestDTO contains standard AbstractRequestDTO parameters

Returns:

response DTO containing all features of the client

setClientFeatures

SetClientFeaturesResponseDTO setClientFeatures(SetClientFeaturesRequestDTO setClientFeaturesRequestDTO)

Update the client features for a given client.

Parameters:

setClientFeaturesRequestDTO - features to update

Returns:

standard response DTO