org.appops.service.event.JobEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of appops-br-service-base Show documentation

appops black rhino service base

There is a newer version: 1.0-RC-5

Show newest version

/*
 * AppOps is a Java framework to develop, deploy microservices with ease and is available for free
 * and common use developed by AinoSoft ( www.ainosoft.com )
 *
 * AppOps and AinoSoft are registered trademarks of Aino Softwares private limited, India.
 *
 * Copyright (C) <2016> 
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version along with applicable additional terms as
 * provisioned by GPL 3.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License and applicable additional terms
 * along with this program.
 *
 * If not, see  and 
 */

package org.appops.service.event;

import org.appops.cache.event.ServiceEvent;
import org.appops.core.job.token.JobToken;

/**
 * An event class which contains Job related information like Job status, job result etc.
 *
 * @author suraj
 * @version $Id: $Id
 */
public class JobEvent extends ServiceEvent {

  /** Constant STARTED="STARTED" */
  public static final String STARTED = "STARTED";
  /** Constant COMPLETED="COMPLETED" */
  public static final String COMPLETED = "COMPLETED";
  private static final String JOB_RESULT = "JOB_RESULT";
  private static final String JOB_TOKEN = "JOB_TOKEN";

  /**
   * default constructor.
   */
  public JobEvent() {

  }

  /**
   * 
   * withJobResult.
   * 
   *
   * @param result a {@link java.lang.Object} object.
   */
  public void withJobResult(Object result) {
    addEventData(JOB_RESULT, result);
  }

  /**
   * 
   * jobResult.
   * 
   *
   * @param  a T object.
   * @return a T object.
   */
  public  T jobResult() {
    return getValue(JOB_RESULT);
  }

  /**
   * 
   * withToken.
   * 
   *
   * @param jobToken a {@link org.appops.core.job.token.JobToken} object.
   */
  public void withToken(JobToken jobToken) {
    addEventData(JOB_TOKEN, jobToken);
  }

  /**
   * 
   * getJobEventStatus.
   * 
   *
   * @return a {@link java.lang.String} object.
   */
  public String getJobEventStatus() {
    return getEventStatus();
  }

  /**
   * Fetch job token from data map .
   *
   * @param  type of job token
   * @return {@link org.appops.core.job.token.JobToken}
   */
  public  T jobToken() {
    return getValue(JobEvent.JOB_TOKEN);

  }

}