|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UnauthenticatedRequestService
This service is used for submission and tracking of requests that doesn't require authentication.
Example: Self Registration.
Method Summary | |
---|---|
RequestModel |
getModel(java.lang.String model) Get the request model given model name |
RequestStatusSummary[] |
getRequestStatusSummary(java.lang.String reqId) Get an array of status changes of a given request. |
RequestDataSet |
getRestrictedDataSet(java.lang.String templateName, java.lang.String entitySubType) Get the restricted data set that is associated with the given template for the given entity. |
RequestTemplate |
getTemplate(java.lang.String templateName) Get the template given a name. |
java.util.List |
getTemplateNames() Get the list of template names that need no authentication. |
java.lang.String |
submitRequest(RequestData requestData) Submit a request for an unauthenticated user Once the target entities and beneficiaries are added, this API should be called. |
Method Detail |
---|
java.util.List getTemplateNames() throws RequestServiceException
RequestServiceException
- if search failsRequestTemplate getTemplate(java.lang.String templateName) throws RequestServiceException
templateName
- - name of the templateRequestServiceException
- - if the template requires authentication or in case of an error while getting the templateRequestModel getModel(java.lang.String model) throws RequestServiceException
model
- - name of the request type/modelRequestServiceException
- - if the model requires authentication or in case of an error while getting the model.RequestDataSet getRestrictedDataSet(java.lang.String templateName, java.lang.String entitySubType) throws RequestServiceException
templateName
- - name of the template.entitySubType
- - Name of the entity sub type for generic entities like "Resource". Can be null for non-generic entities like "User".RequestServiceException
- if data validation or search failsjava.lang.String submitRequest(RequestData requestData) throws InvalidRequestException, InvalidRequestDataException, RequestServiceException, BulkBeneficiariesAddException, BulkEntitiesAddException
reqData
- RequestData objectInvalidRequestException,
- if requestData object is invalidRequestServiceException
- if request creation failsInvalidRequestDataException
- if data validation failsBulkBeneficiariesAddException
BulkEntitiesAddException
InvalidRequestException
RequestStatusSummary[] getRequestStatusSummary(java.lang.String reqId) throws RequestServiceException
reqId,
- Id of the requestRequestServiceException
- if search fails
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |