cz.active24.client.fred.data.poll.other.RequestUsagePollResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fred-client Show documentation
A Java EPP client for FRED (Free Registry for ENUM and Domains)
There is a newer version: 2.50
package cz.active24.client.fred.data.poll.other;

import cz.active24.client.fred.data.poll.PollResponse;
import cz.active24.client.fred.eppclient.objectstrategy.PollMessageType;

import java.io.Serializable;
import java.math.BigDecimal;
import java.util.Date;

/**
 * Event: Daily report of how many free requests have been made this month so far, and how much the client will be charged for the requests that exceed the limit.
 *
 * 
 * {@link RequestUsagePollResponse#periodFrom} - the timestamp of the start of the period
 * {@link RequestUsagePollResponse#periodTo} - the timestamp of the end of the period
 * {@link RequestUsagePollResponse#totalFreeCount} - the amount of free requests (the limit) for this month
 * {@link RequestUsagePollResponse#usedCount} - the total of requests used during the period
 * {@link RequestUsagePollResponse#price} - additional charge for requests over the limit that the client will be billed
 * 
 *
 * @see FRED documentation
 */
public class RequestUsagePollResponse extends PollResponse implements Serializable {

    private Date periodFrom;

    private Date periodTo;

    private Integer totalFreeCount;

    private Integer usedCount;

    private BigDecimal price;

    public RequestUsagePollResponse() {
        setPollMessageType(PollMessageType.REQUEST_USAGE);
    }

    public Date getPeriodFrom() {
        return periodFrom;
    }

    public void setPeriodFrom(Date periodFrom) {
        this.periodFrom = periodFrom;
    }

    public Date getPeriodTo() {
        return periodTo;
    }

    public void setPeriodTo(Date periodTo) {
        this.periodTo = periodTo;
    }

    public Integer getTotalFreeCount() {
        return totalFreeCount;
    }

    public void setTotalFreeCount(Integer totalFreeCount) {
        this.totalFreeCount = totalFreeCount;
    }

    public Integer getUsedCount() {
        return usedCount;
    }

    public void setUsedCount(Integer usedCount) {
        this.usedCount = usedCount;
    }

    public BigDecimal getPrice() {
        return price;
    }

    public void setPrice(BigDecimal price) {
        this.price = price;
    }

    @Override
    public String toString() {
        final StringBuffer sb = new StringBuffer("RequestUsagePollResponse{");
        sb.append("periodFrom=").append(periodFrom);
        sb.append(", periodTo=").append(periodTo);
        sb.append(", totalFreeCount=").append(totalFreeCount);
        sb.append(", usedCount=").append(usedCount);
        sb.append(", price=").append(price);
        sb.append(", messageId='").append(getMessageId()).append('\'');
        sb.append(", messageCount=").append(getMessageCount());
        sb.append(", messageQDate=").append(getMessageQDate());
        sb.append(", pollMessageType=").append(getPollMessageType());
        sb.append(", clientTransactionId='").append(getClientTransactionId()).append('\'');
        sb.append(", serverTransactionId='").append(getServerTransactionId()).append('\'');
        sb.append(", result=").append(getResult());
        sb.append(", serverObjectType=").append(getServerObjectType());
        sb.append('}');
        return sb.toString();
    }
}