MeasurementScheduleComposite.java

/*
 * RHQ Management Platform
 * Copyright (C) 2005-2008 Red Hat, Inc.
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2, as
 * published by the Free Software Foundation, and/or the GNU Lesser
 * General Public License, version 2.1, also as published by the Free
 * Software Foundation.
 *
 * 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 and the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * and the GNU Lesser General Public License along with this program;
 * if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package org.rhq.core.domain.measurement.composite;

import java.io.Serializable;

import org.rhq.core.domain.measurement.MeasurementDefinition;

/**
 * A composite object used to display metric collection schedules - represents one of the following:
 *
 * <ul>
 *   <li>the metric collection schedule for a resource</li>
 *   <li>the metric collection schedule for a compatible group or autogroup</li>
 *   <li>the default metric collection schedule for a resource type</li>
 * </ul>
 *
 * @author Ian Springer
 * @author Joseph Marques
 */
public class MeasurementScheduleComposite implements Serializable {

    private static final long serialVersionUID = 1L;

    private MeasurementDefinition measurementDefinition;
    private Boolean collectionEnabled; // null flagged as "SOME"
    private long collectionInterval; // 0 flagged as "DIFFERENT"

    // No-arg constructor required by GWT.
    public MeasurementScheduleComposite() {
    }

    public MeasurementScheduleComposite(MeasurementDefinition measurementDefinition) {
        this.measurementDefinition = measurementDefinition;
        this.collectionEnabled = measurementDefinition.isDefaultOn();
        this.collectionInterval = measurementDefinition.getDefaultInterval();
    }

    public MeasurementScheduleComposite(MeasurementDefinition measurementDefinition, Boolean collectionEnabled,
        long collectionInterval) {
        this.measurementDefinition = measurementDefinition;
        this.collectionEnabled = collectionEnabled;
        this.collectionInterval = collectionInterval;
    }

    public MeasurementDefinition getMeasurementDefinition() {
        return this.measurementDefinition;
    }

    public Boolean getCollectionEnabled() {
        return this.collectionEnabled;
    }

    public long getCollectionInterval() {
        return this.collectionInterval;
    }

    @Override
    public String toString() {
        return "MeasurementScheduleComposite[measurementDefinition=" + this.measurementDefinition
            + ", collectionEnabled=" + this.collectionEnabled + ", collectionInterval=" + this.collectionInterval + "]";
    }
}