package com.temboo.Library.PayPal.Payments;

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

	
/**
	A ResultSet with methods tailored to the values returned by the LookupPayment Choreo.
	The ResultSet object is used to retrieve the results of a Choreo execution.
*/
public  class LookupPaymentResultSet extends ResultSet {
		
	public LookupPaymentResultSet(JSONObject doc) {
		super(doc);
	}

	/** 
	Retrieve the value for the "Currency" output from this Choreo execution

	@return String - (string) The payment currency.
	*/
	public String getCurrency() {
		return this.getResultString("Currency");
	}
	/** 
	Retrieve the value for the "NewAccessToken" output from this Choreo execution

	@return String - (string) The new access token retrieved from PayPal when providing the Client ID and Client Secret.
	*/
	public String getNewAccessToken() {
		return this.getResultString("NewAccessToken");
	}
	/** 
	Retrieve the value for the "PaymentState" output from this Choreo execution

	@return String - (string) The state of the payment.
	*/
	public String getPaymentState() {
		return this.getResultString("PaymentState");
	}
	/** 
	Retrieve the value for the "SaleState" output from this Choreo execution

	@return String - (string) The state of the sale.
	*/
	public String getSaleState() {
		return this.getResultString("SaleState");
	}
	/** 
	Retrieve the value for the "Total" output from this Choreo execution

	@return String - (decimal) The total amount of the payment.
	*/
	public String getTotal() {
		return this.getResultString("Total");
	}
	/** 
	Retrieve the value for the "Response" output from this Choreo execution

	@return String - (json) The response from PayPal.
	*/
	public String getResponse() {
		return this.getResultString("Response");
	}
}