com.telekom.m2m.cot.restsdk.retentionrule.RetentionRule Maven / Gradle / Ivy

Go to download
package com.telekom.m2m.cot.restsdk.retentionrule;

import com.telekom.m2m.cot.restsdk.util.CotSdkException;
import com.telekom.m2m.cot.restsdk.util.ExtensibleObject;


/**
 * RetentionRules govern after what time old data is to be removed from the cloud.
 * Each type of document can have its own rule, so that some types can be kept longer,
 * while others get cleaned up faster.
 */
public class RetentionRule extends ExtensibleObject {

    public static final String DATA_TYPE_EVENT = "EVENT";
    public static final String DATA_TYPE_MEASUREMENT = "MEASUREMENT";
    public static final String DATA_TYPE_ALARM = "ALARM";
    public static final String DATA_TYPE_AUDIT = "AUDIT";
    public static final String DATA_TYPE_OPERATION = "OPERATION";
    public static final String DATA_TYPE_ALL = "*";


    /**
     * Constructor to create a new empty rule.
     */
    public RetentionRule() {
        super();
    }

    /**
     * Internal constructor to create rules from base class.
     *
     * @param extensibleObject object from base class.
     */
    RetentionRule(ExtensibleObject extensibleObject) {
        super(extensibleObject);
    }


    /**
     * Get the unique identifier of the rule.
     * If the rule was retrieved from the platform, it has an ID. If just
     * created, there is no ID.
     *
     * @return Long the unique identifier of the rule or null if not available.
     */
    public Long getId() {
        Object id = anyObject.get("id");
        if (id == null) {
            return null;
        }

        if (id instanceof Number) {
            return ((Number) id).longValue();
        }
        if (id instanceof String) {
            return Long.parseLong((String) id);
        }
        try {
            return (Long) id;
        } catch (ClassCastException ex) {
            throw new CotSdkException("RetentionRule has invalid id in json.", ex);
        }
    }

    /**
     * Set the unique identifier of the rule.
     * Just used internally.
     *
     * @param id the new identifier.
     */
    void setId(Long id) {
        anyObject.put("id", id);
    }


    /**
     * Get the type of the rule.
     * The type categorizes the rule.
     *
     * @return a String with the type or null if not available.
     */
    public String getType() {
        return (String) anyObject.get("type");
    }

    /**
     * Setting the rule type.
     *
     * @param type a String with the rule type. Use cot_abc_xyz style.
     */
    public void setType(String type) {
        anyObject.put("type", type);
    }


    /**
     * Get the dataType of the rule.
     * The type categorizes the rule.
     *
     * @return a String with the dataType or null if not available.
     */
    public String getDataType() {
        return (String) anyObject.get("dataType");
    }

    /**
     * Setting the rule dataType.
     *
     * @param dataType a String with the rule dataType. Use cot_abc_xyz style.
     */
    public void setDataType(String dataType) {
        anyObject.put("dataType", dataType);
    }


    /**
     * Get the fragmentType of the rule.
     * The type categorizes the rule.
     *
     * @return a String with the fragmentType or null if not available.
     */
    public String getFragmentType() {
        return (String) anyObject.get("fragmentType");
    }

    /**
     * Setting the rule fragmentType.
     *
     * @param fragmentType a String with the rule fragmentType. Use cot_abc_xyz style.
     */
    public void setFragmentType(String fragmentType) {
        anyObject.put("fragmentType", fragmentType);
    }


    /**
     * Get the source of the rule.
     *
     * @return a String with the source or null if not available.
     */
    public String getSource() {
        return (String) anyObject.get("source");
    }

    /**
     * Setting the rule fragmentType.
     *
     * @param source a String with the rule source.
     */
    public void setSource(String source) {
        anyObject.put("source", source);
    }


    /**
     * Get the maximumAge of the rule in days.
     *
     * @return an int with the maximumAge
     */
    public int getMaximumAge() {
        Object maximumAge = anyObject.get("maximumAge");

        if (maximumAge == null) {
            return 0;
        }

        if (maximumAge instanceof Number) {
            return ((Number) maximumAge).intValue();
        }
        if (maximumAge instanceof String) {
            return Integer.parseInt((String) maximumAge);
        }
        try {
            return (int) maximumAge;
        } catch (ClassCastException ex) {
            throw new CotSdkException("RetentionRule has invalid maximumAge in json.", ex);
        }
    }

    /**
     * Setting the rule maximumAge in days.
     *
     * @param maximumAge an int with the rule maximumAge.
     */
    public void setMaximumAge(int maximumAge) {
        anyObject.put("maximumAge", maximumAge);
    }


    /**
     * Get the editable-flag of the rule.
     *
     * @return the boolean editable-flag
     */
    public boolean isEditable() {
        Object editable = anyObject.get("editable");
        return (editable != null) && (boolean)editable;
    }

    /**
     * Setting the  editable-flag of the rule.
     *
     * @param editable flag
     */
    public void setEditable(boolean editable) {
        anyObject.put("editable", editable);
    }

}