com.client.core.formtrigger.workflow.traversing

Class AbstractValidationTraverser<T extends FormTriggerHelper<?,?>>

java.lang.Object

com.client.core.formtrigger.workflow.traversing.AbstractValidationTraverser<T>

All Implemented Interfaces:

Traverser, ValidationTraverser

Direct Known Subclasses:

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

public class AbstractValidationTraverser<T extends FormTriggerHelper<?,?>>
extends java.lang.Object
implements ValidationTraverser

Constructor Summary

Constructors

Constructor and Description
AbstractValidationTraverser(T formTriggerHelper, java.lang.Integer corporationID, boolean edit)

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.
T	getFormTriggerHelper()
boolean	isEdit() Returns whether or not the form trigger currently being validated is an edit trigger or not.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractValidationTraverser

public AbstractValidationTraverser(T formTriggerHelper,
                                   java.lang.Integer corporationID,
                                   boolean edit)

Method Detail

getFormTriggerHelper

public T getFormTriggerHelper()

getCorporationID

public java.lang.Integer getCorporationID()

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

Specified by:

getCorporationID in interface ValidationTraverser

Returns:

the corporationID

getFormResponse

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

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

Specified by:

getFormResponse in interface ValidationTraverser

Returns:

the formResponse

See Also:

ValidationTraverser.addFormResponse(String, String)

addFormResponse

public 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.

Specified by:

addFormResponse in interface ValidationTraverser

Parameters:

key - the key of the reponse item

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

isEdit

public boolean isEdit()

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

Specified by:

isEdit in interface ValidationTraverser

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object