Class InsightsEventPublisher
- java.lang.Object
-
- com.avoka.fc.core.service.insights.InsightsEventPublisher
-
public class InsightsEventPublisher extends Object
Provides a Insights event publisher class.- Since:
- 17.10.4
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
InsightsEventPublisher.EventType
The Insights Event Types.
-
Constructor Summary
Constructors Constructor Description InsightsEventPublisher()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
send()
Send the Insights transaction event.InsightsEventPublisher
setEventType(InsightsEventPublisher.EventType eventType)
Set the Insights event type.InsightsEventPublisher
setJob(Job job)
Set the Insights job to publishInsightsEventPublisher
setJobAction(JobAction jobAction)
Set the Insights job action to publishInsightsEventPublisher
setJobStep(JobStep jobStep)
Set the Insights job step to publishInsightsEventPublisher
setName(String name)
Set the Insights event name to publish.InsightsEventPublisher
setSubmission(Submission submission)
Set the Insights submission event to publishInsightsEventPublisher
setValue(String value)
Set the Insights event value to publish.
-
-
-
Method Detail
-
setEventType
public InsightsEventPublisher setEventType(InsightsEventPublisher.EventType eventType)
Set the Insights event type.- Parameters:
eventType
- the Insights event type- Returns:
- the event publisher
-
setName
public InsightsEventPublisher setName(String name)
Set the Insights event name to publish.- Parameters:
name
- the Insights event name to publish- Returns:
- the event publisher
- Since:
- 18.5.0
-
setValue
public InsightsEventPublisher setValue(String value)
Set the Insights event value to publish.- Parameters:
value
- the Insights event value to publish- Returns:
- the event publisher
-
setSubmission
public InsightsEventPublisher setSubmission(Submission submission)
Set the Insights submission event to publish- Parameters:
submission
- the Insights submission event to publish- Returns:
- the event publisher
-
setJob
public InsightsEventPublisher setJob(Job job)
Set the Insights job to publish- Parameters:
job
-- Returns:
-
setJobStep
public InsightsEventPublisher setJobStep(JobStep jobStep)
Set the Insights job step to publish- Parameters:
jobStep
-- Returns:
-
setJobAction
public InsightsEventPublisher setJobAction(JobAction jobAction)
Set the Insights job action to publish- Parameters:
jobAction
-- Returns:
-
send
public boolean send()
Send the Insights transaction event. This method will log any errors which occur to the Error Log table and return false if the event could not be sent.- Returns:
- true if the event was sent or false otherwise
-
-