org.labkey.remoteapi.study.CheckForStudyReloadCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of labkey-client-api Show documentation

The client-side library for Java developers is a separate JAR from the LabKey Server code base. It can be used by any Java program, including another Java web application.

The newest version!

/*
 * Copyright (c) 2015-2018 LabKey Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.labkey.remoteapi.study;

import org.labkey.remoteapi.CommandResponse;
import org.labkey.remoteapi.PostCommand;

import java.util.Map;

/**
 * Pings an existing LabKey study to check to see if it needs to be reloaded from a study archive on disk.
 * Created by: jeckels
 * Date: 7/12/15
 */
public class CheckForStudyReloadCommand extends PostCommand
{
    private final boolean _skipQueryValidation;
    private final boolean _failForUndefinedVisits;

    public CheckForStudyReloadCommand()
    {
        this(true, false);
    }

    public CheckForStudyReloadCommand(boolean skipQueryValidation)
    {
        this(skipQueryValidation, false);
    }

    public CheckForStudyReloadCommand(boolean skipQueryValidation, boolean failForUndefinedVisits)
    {
        super("study", "checkForReload");
        _skipQueryValidation = skipQueryValidation;
        _failForUndefinedVisits = failForUndefinedVisits;
    }

    @Override
    public Map getParameters()
    {
        Map parameters = super.getParameters();
        if (_skipQueryValidation)
        {
            parameters.put("skipQueryValidation", "1");
        }
        if (_failForUndefinedVisits)
        {
            parameters.put("failForUndefinedVisits", "1");
        }
        return parameters;
    }
}