com.yodlee.api.model.transaction.RuleClause Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yodlee-api-model-beta Show documentation
Yodlee API Model Beta is the stage version
There is a newer version: 1.0.29.beta1
Show newest version
/**
 * Copyright (c) 2019 Yodlee, Inc. All Rights Reserved.
 *
 * Licensed under the MIT License. See LICENSE file in the project root for license information.
 */
package com.yodlee.api.model.transaction;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.yodlee.api.model.AbstractModelComponent;
import com.yodlee.api.model.transaction.enums.Operation;
import com.yodlee.api.model.transaction.enums.TransactionClauseType;
import io.swagger.annotations.ApiModelProperty;

@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({"ruleClauseId", "userDefinedRuleId", "field", "operation", "fieldValue"})
public class RuleClause extends AbstractModelComponent {

	@ApiModelProperty(readOnly = true,
					  value = "Unique identifier generated for the rule clause."//
							  + "

"//
							  + "Applicable containers: creditCard, investment, insurance, loan
"//
	)
	@JsonProperty("ruleClauseId")
	private Long ruleClauseId;

	@ApiModelProperty(readOnly = true,
					  value = "Unique identifier generated for every rule the user creates."//
							  + "

"//
							  + "Applicable containers: creditCard, investment, insurance, loan
"//
	)
	@JsonProperty("userDefinedRuleId")
	private Long userDefinedRuleId;

	@ApiModelProperty(readOnly = true,
					  value = "Field for which the clause is created."//
							  + "

"//
							  + "
Valid Values:amount,description"//
							  + "Applicable containers: creditCard, investment, insurance, loan
"//
	)
	@JsonProperty("field")
	private TransactionClauseType field;

	@ApiModelProperty(readOnly = true,
					  value = "Operation for which the clause is created."//
							  + "

"//
							  + "Applicable containers: creditCard, investment, insurance, loan
"//
	)
	@JsonProperty("operation")
	private Operation operation;

	@ApiModelProperty(readOnly = true,
					  value = "The value would be the amount value in case of amount based rule clause or the string value in case of description based rule clause."//
							  + "

"//
							  + "Applicable containers: creditCard, investment, insurance, loan
"//
	)
	@JsonProperty("fieldValue")
	private String fieldValue;

	/**
	 * Field for which the clause is created. 

	 * 

	 * 

	 * Valid Values:amount,description Applicable containers: creditCard, investment, insurance,
	 * loan

	 * 
	 * @return field
	 */
	public TransactionClauseType getField() {
		return field;
	}

	public void setField(TransactionClauseType field) {
		this.field = field;
	}

	/**
	 * Operation for which the clause is created. 

	 * 

	 * Applicable containers: creditCard, investment, insurance, loan

	 * 
	 * @return operation
	 */
	public Operation getOperation() {
		return operation;
	}

	public void setOperation(Operation operation) {
		this.operation = operation;
	}

	/**
	 * Unique identifier generated for the rule clause. 

	 * 

	 * Applicable containers: creditCard, investment, insurance, loan

	 * 
	 * @return ruleClauseId
	 */
	public Long getRuleClauseId() {
		return ruleClauseId;
	}

	public void setRuleClauseId(Long ruleClauseId) {
		this.ruleClauseId = ruleClauseId;
	}

	/**
	 * The value would be the amount value in case of amount based rule clause or the string value in case of
	 * description based rule clause. 

	 * 

	 * Applicable containers: creditCard, investment, insurance, loan

	 * 
	 * @return fieldValue
	 */
	public String getFieldValue() {
		return fieldValue;
	}

	public void setFieldValue(String fieldValue) {
		this.fieldValue = fieldValue;
	}

	/**
	 * Unique identifier generated for every rule the user creates. 

	 * 

	 * Applicable containers: creditCard, investment, insurance, loan

	 * 
	 * @return userDefinedRuleId
	 */
	public Long getUserDefinedRuleId() {
		return userDefinedRuleId;
	}

	public void setUserDefinedRuleId(Long userDefinedRuleId) {
		this.userDefinedRuleId = userDefinedRuleId;
	}

	@Override
	public String toString() {
		return "RuleClauses [ruleClauseId=" + ruleClauseId + ", userDefinedRuleId=" + userDefinedRuleId + ", field="
				+ field + ", operation=" + operation + ", fieldValue=" + fieldValue + "]";
	}
}