AbstractConfigurationUpdateCriteria.java

/*
 * RHQ Management Platform
 * Copyright (C) 2005-2011 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.criteria;

import java.util.List;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;

import org.rhq.core.domain.configuration.ConfigurationUpdateStatus;
import org.rhq.core.domain.util.CriteriaUtils;
import org.rhq.core.domain.util.PageOrdering;

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public abstract class AbstractConfigurationUpdateCriteria extends Criteria {
    private static final long serialVersionUID = 2L;

    public static final String SORT_FIELD_CREATED_TIME = "createdTime";

    public static final String SORT_FIELD_STATUS = "status";

    public static final String FETCH_FIELD_CONFIGURATION = "configuration";

    private Long filterStartTime; // requires overrides
    private Long filterEndTime; // requires overrides
    private ConfigurationUpdateStatus filterStatus;
    private List<ConfigurationUpdateStatus> filterStatuses; // requires overrides

    private boolean fetchConfiguration;

    private PageOrdering sortCreatedTime;
    private PageOrdering sortStatus; // requires sort override

    public AbstractConfigurationUpdateCriteria() {
        filterOverrides.put("startTime", "createdTime >= ?");
        filterOverrides.put("endTime", "createdTime <= ?");
        filterOverrides.put("statuses", "status IN ( ? )");
    }

    /**
     * @param filterIds list of ids to filter
     * @deprecated since 4.7.0 use {@link Criteria#addFilterIds(Integer... filterIds)} instead
     */
    @Deprecated
    public void addFilterIds(List<Integer> filterIds) {
        super.addFilterIds(filterIds != null ? filterIds.toArray(new Integer[filterIds.size()]) : null);
    }

    public void addFilterStartTime(Long filterStartTime) {
        this.filterStartTime = filterStartTime;
    }

    public void addFilterEndTime(Long filterEndTime) {
        this.filterEndTime = filterEndTime;
    }

    public void addFilterStatus(ConfigurationUpdateStatus status) {
        this.filterStatus = status;
    }

    public void addFilterStatuses(ConfigurationUpdateStatus... configUpdateStatus) {
        this.filterStatuses = CriteriaUtils.getListIgnoringNulls(configUpdateStatus);
    }

    /**
     * @param fetchConfiguration If true then fetch the configuration associated with the update.
     */
    public void fetchConfiguration(boolean fetchConfiguration) {
        this.fetchConfiguration = fetchConfiguration;
    }

    public void addSortCreatedTime(PageOrdering sortCreatedTime) {
        addSortField(SORT_FIELD_CREATED_TIME);
        this.sortCreatedTime = sortCreatedTime;
    }

    public void addSortStatus(PageOrdering sortStatus) {
        addSortField(SORT_FIELD_STATUS);
        this.sortStatus = sortStatus;
    }
}