com.client.core.formtrigger.workflow.traversing

Interface ValidationTraverser

All Superinterfaces:

Traverser

All Known Implementing Classes:

AbstractValidationTraverser, CandidateValidationTraverser, ClientContactValidationTraverser, ClientCorporationValidationTraverser, JobSubmissionValidationTraverser, JobValidationTraverser, NoteValidationTraverser, PlacementChangeRequestValidationTraverser, PlacementValidationTraverser

public interface ValidationTraverser
extends Traverser

Created by john.sullivan on 2/11/2015.

Method Summary

Modifier and Type	Method and Description
void	addFormResponse(java.lang.String key, java.lang.String message) Contains the response that will be sent back to the bullhorn form, key:value pairs can be either validation error messages or response values for the form.
java.lang.Integer	getCorporationID() Return the corporationID of the corporation for which an entity is being validated
java.util.Map<java.lang.String,java.lang.String>	getFormResponse() Returns the response that will be sent back to the bullhorn form.
boolean	isEdit() Returns whether or not the form trigger currently being validated is an edit trigger or not.

Method Detail

getCorporationID

java.lang.Integer getCorporationID()

Return the corporationID of the corporation for which an entity is being validated

Returns:

the corporationID

getFormResponse

java.util.Map<java.lang.String,java.lang.String> getFormResponse()

Returns the response that will be sent back to the bullhorn form.

Returns:

the formResponse

See Also:

addFormResponse(String, String)

addFormResponse

void addFormResponse(java.lang.String key,
                     java.lang.String message)

Contains the response that will be sent back to the bullhorn form, key:value pairs can be either validation error messages or response values for the form. Any key starting with either "error","block" or "validation" will be treated as a validation blocking error. The value will be displayed to user on the bullhorn form. Any key starting with "returnvalue:" will be treated as a return value to populate the form, the text following the "returnvalue:" in the key is the field to update. The value in the map is the value to populate the field with. Example "returnvalue:status":"Closed", this will return "Closed" to the status field.

Parameters:

key - the key of the reponse item

message - the message or value to be returned to the bullhorn form

isEdit

boolean isEdit()

Returns whether or not the form trigger currently being validated is an edit trigger or not.

Returns:

true if the form trigger is edit, false if it is add