com.arm.mbed.cloud.sdk.billing.model.QuotaHistory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mbed-cloud-sdk Show documentation

The Pelion Cloud SDK (formerly known as Mbed Cloud SDK) provides a simplified interface to the Pelion Cloud APIs by exposing functionality using conventions and paradigms familiar to Java developers.

There is a newer version: 2.5.0

Show newest version

package com.arm.mbed.cloud.sdk.billing.model;

import java.util.Date;

import com.arm.mbed.cloud.sdk.annotations.Internal;
import com.arm.mbed.cloud.sdk.annotations.Preamble;
import com.arm.mbed.cloud.sdk.common.SdkModel;

@Preamble(description = "An audit history entry for billing entities")
public class QuotaHistory implements SdkModel {
    /**
     * Serialisation Id.
     */
    private static final long serialVersionUID = -3797353685003557513L;
    private String id;
    private final Date createdAt;
    private final long delta;
    private final String reason;
    private final AbstractBillingEntity transactionReference;

    /**
     * Internal Constructor.
     *
     * @param id
     *            id
     * @param createdAt
     *            createdAt
     * @param delta
     *            delta
     * @param reason
     *            reason
     * @param ref
     *            reference
     */
    @Internal
    public QuotaHistory(String id, Date createdAt, long delta, String reason, AbstractBillingEntity ref) {
        super();
        this.id = id;
        this.createdAt = createdAt;
        this.delta = delta;
        this.reason = reason;
        this.transactionReference = ref;

    }

    /**
     * Constructor.
     */
    public QuotaHistory() {
        this(null, new Date(), 0L, null, null);
    }

    /**
     * Gets the ID.
     *
     * @return the id
     */
    @Override
    public String getId() {
        return id;
    }

    /**
     * Gets when this entry was created.
     *
     * @return the createdAt
     */
    public Date getCreatedAt() {
        return createdAt;
    }

    /**
     * Gets the change in remaining value, at the time this entry was created.
     * 
     * Note: Negative values mean the remaining amount has been reduced.
     * 
     * for example, a reservation caused by starting a campaign.
     *
     * @return the delta
     */
    public long getDelta() {
        return delta;
    }

    /**
     * Gets the reason why this entry was created.
     *
     * @return the reason
     */
    public String getReason() {
        return reason;
    }

    /**
     * Gets the campaign reservation that this entry refers to.
     *
     * @return the reservation
     */
    public Reservation getReservation() {
        return transactionReference instanceof Reservation ? (Reservation) transactionReference : null;
    }

    /**
     * Gets the service package that this entry refers to.
     *
     * @return the servicePackage
     */
    public ServicePackage getServicePackage() {
        return transactionReference instanceof ServicePackage ? (ServicePackage) transactionReference : null;
    }

    /**
     * Gets the reference of this quota action.
     *
     * @return the reference
     */
    public AbstractBillingEntity getTransactionReference() {
        return transactionReference;
    }

    /**
     * Sets the ID.
     *
     * @param id
     *            the id to set
     */
    public void setId(String id) {
        this.id = id;
    }

    @Override
    public QuotaHistory clone() {
        return new QuotaHistory(id, createdAt, delta, reason,
                                transactionReference == null ? null : transactionReference.clone());
    }

    @Override
    public boolean isValid() {
        return true;
    }

    /*
     * (non-Javadoc)
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return "QuotaHistory [id=" + id + ", createdAt=" + createdAt + ", delta=" + delta + ", reason=" + reason
               + ", transaction reference=" + transactionReference + "]";
    }

}