ProjectWorkspaceListCall.java

/*
 * ProjectWorkspaceListCall.java
 *
 * Copyright (C) 2010-2016, Microsoft Corporation
 *
 * This program is licensed to you under the terms of Version 2.0 of the
 * Apache License. This program is distributed WITHOUT
 * ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
 * Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0) for more details.
 *
 */
package com.revo.deployr.client.call.project;

import com.revo.deployr.client.call.AbstractCall;
import com.revo.deployr.client.core.RCoreResult;
import com.revo.deployr.client.core.REndpoints;
import com.revo.deployr.client.params.ProjectWorkspaceOptions;

import java.util.concurrent.Callable;

/**
 * Provides support for DeployR API call: /r/project/workspace/list.
 * <p/>
 * Simply construct an instance of this call and pass it on the
 * execute() method of your {@link com.revo.deployr.client.RClient}.
 */
public class ProjectWorkspaceListCall extends AbstractCall
        implements Callable<RCoreResult> {

    private final String API = REndpoints.RPROJECTWORKSPACELIST;

    public ProjectWorkspaceListCall(String project, ProjectWorkspaceOptions options) {
        httpParams.put("project", project);

        if (options != null) {
            httpParams.put("root", options.alternateRoot);
            httpParams.put("filter", options.startsWithFilter);
            httpParams.put("clazz", options.clazzFilter);
            httpParams.put("pagesize", Integer.toString(options.pagesize));
            httpParams.put("pageoffset", Integer.toString(options.pageoffset));
        }

        httpParams.put("format", "json");
    }

    /**
     * Internal use only, to execute call use RClient.execute().
     */
    public RCoreResult call() {

        return makeGetRequest(API);
    }

}