com.fluidbpm.program.api.vo.report.system.SystemUpHourMin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fluid-api Show documentation

Used for the * Custom Program Step, * Custom Actions, * Scheduled Actions and * Fluid API in the Fluid BPM and Content Management system.

There is a newer version: 1.12

Show newest version

/*
 * Koekiebox CONFIDENTIAL
 *
 * [2012] - [2017] Koekiebox (Pty) Ltd
 * All Rights Reserved.
 *
 * NOTICE: All information contained herein is, and remains the property
 * of Koekiebox and its suppliers, if any. The intellectual and
 * technical concepts contained herein are proprietary to Koekiebox
 * and its suppliers and may be covered by South African and Foreign Patents,
 * patents in process, and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material is strictly
 * forbidden unless prior written permission is obtained from Koekiebox.
 */

package com.fluidbpm.program.api.vo.report.system;

import com.fluidbpm.program.api.vo.ABaseFluidJSONObject;
import com.fluidbpm.program.api.vo.report.ABaseFluidJSONReportObject;
import lombok.Getter;
import lombok.Setter;
import org.json.JSONException;
import org.json.JSONObject;

/**
 * User statistics.
 *
 * @author jasonbruwer on 2020-08-20
 * @since v1.11
 * 
 * @see ABaseFluidJSONObject
 */
@Getter
@Setter
public class SystemUpHourMin extends ABaseFluidJSONReportObject {
	public static final long serialVersionUID = 1L;

	private int hour;
	private int minute;
	private State state = State.Unknown;

	public static enum State {
		Unknown, Up, Down
	}

	/**
	 * The JSON mapping for the {@code SystemUpHourMin} object.
	 */
	public static class JSONMapping {
		public static final String HOUR = "hour";
		public static final String MINUTE = "minute";
		public static final String STATE = "state";
	}

	/**
	 * Default constructor.
	 */
	public SystemUpHourMin() {
		super();
	}

	/**
	 * Populates local variables with {@code jsonObjectParam}.
	 *
	 * @param jsonObjectParam The JSON Object.
	 */
	public SystemUpHourMin(JSONObject jsonObjectParam) {
		super(jsonObjectParam);
		if (this.jsonObject == null) {
			return;
		}

		if (this.jsonObject.isNull(JSONMapping.HOUR)) {
			this.setHour(0);
		} else {
			this.setHour(this.jsonObject.getInt(JSONMapping.HOUR));
		}

		if (this.jsonObject.isNull(JSONMapping.MINUTE)) {
			this.setMinute(0);
		} else {
			this.setMinute(this.jsonObject.getInt(JSONMapping.MINUTE));
		}

		if (this.jsonObject.isNull(JSONMapping.STATE)) {
			this.setState(State.Unknown);
		} else {
			this.setState(State.valueOf(this.jsonObject.getString(JSONMapping.STATE)));
		}
	}

	/**
	 * Conversion to {@code JSONObject} from Java Object.
	 *
	 * @return {@code JSONObject} representation of {@code SystemUpHourMin}
	 * @throws JSONException If there is a problem with the JSON Body.
	 *
	 * @see ABaseFluidJSONObject#toJsonObject()
	 */
	@Override
	public JSONObject toJsonObject() throws JSONException {
		JSONObject returnVal = super.toJsonObject();

		returnVal.put(JSONMapping.HOUR, this.getHour());
		returnVal.put(JSONMapping.MINUTE, this.getMinute());
		if (this.getState() != null) {
			returnVal.put(JSONMapping.STATE, this.getState());
		}

		return returnVal;
	}

	/**
	 * Comparing the hour and minute.
	 *
	 * @return {@code ((this.getHour() * 100) + this.getMinute())}
	 */
	public long comparingHourMinute() {
		return ((this.getHour() * 100) + this.getMinute());
	}
}