package com.temboo.Library.DonorsChoose;

/*
Copyright 2014 Temboo, Inc.

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.
*/

import processing.data.JSONArray;
import processing.data.JSONObject;
import java.math.BigDecimal;
import com.temboo.core.Choreography;
import com.temboo.core.Choreography.ResultSet;
import com.temboo.core.TembooException;
import com.temboo.core.TembooPath;
import com.temboo.core.TembooSession;

/** 
SearchProjectsByKeyword

Allows you to projects subjects by keyword.
*/
public class SearchProjectsByKeyword extends Choreography {

	/**
	Create a new instance of the SearchProjectsByKeyword Choreo. A TembooSession object, containing a valid
	set of Temboo credentials, must be supplied.
	*/
	public SearchProjectsByKeyword(TembooSession session) {
		super(session, TembooPath.pathFromStringNoException("/Library/DonorsChoose/SearchProjectsByKeyword"));
	}

	/** 
	Set the value of the APIKey input for this Choreo. 

	@param String - (optional, string) The APIKey provided by DonorsChoose.org. Defaults to the test  APIKey 'DONORSCHOOSE'.
	*/
	public void setAPIKey(String value) {
		this.inputs.setInput("APIKey", value);
	}


	/** 
	Set the value of the Keyword input for this Choreo. 

	@param String - (required, string) Allows you to search for subjects using keyword search
	*/
	public void setKeyword(String value) {
		this.inputs.setInput("Keyword", value);
	}


	/** 
	Set the value of the Max input for this Choreo. 

	@param Integer - (optional, integer) The max number of projects to return. Can return up to 50 rows at a time. Defaults to 10 when left empty.
	*/
	public void setMax(Integer value) {
		this.inputs.setInput("Max", value);
	}

	/** 
	Set the value of the Max input for this Choreo as a String. 

	@param String - (optional, integer) The max number of projects to return. Can return up to 50 rows at a time. Defaults to 10 when left empty.
	*/
	public void setMax(String value) {
		this.inputs.setInput("Max", value);	
	}
	/** 
	Set the value of the ResponseFormat input for this Choreo. 

	@param String - (optional, string) The format that the response should be in. Can be set to xml or json. Defaults to xml.
	*/
	public void setResponseFormat(String value) {
		this.inputs.setInput("ResponseFormat", value);
	}


	
	/**
	 * Execute the Choreo, wait for the Choreo to complete 
	 * and return a ResultSet containing the execution results.
	 */
	@Override
	public SearchProjectsByKeywordResultSet run() {
		JSONObject result = super.runWithResults();
		return new SearchProjectsByKeywordResultSet(result);
	}
	
}
