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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yodlee-api-model Show documentation
Yodlee API Model
There is a newer version: 1.1.31
/**
 * 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 java.util.Collections;
import java.util.List;
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 io.swagger.annotations.ApiModelProperty;

@JsonPropertyOrder({"userDefinedRuleId", "memId", "transactionCategorisationId", "rulePriority", "categoryLevelId"})
@JsonInclude(JsonInclude.Include.NON_NULL)
public class TransactionCategorizationRule extends AbstractModelComponent {

	@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 = "Unique identifier of the user."//
							  + "

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

	@ApiModelProperty(readOnly = true,
					  value = "Category id that is assigned to the transaction when the transaction matches the rule clause. This is the id field of the transaction category resource."//
							  + "

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

	@ApiModelProperty(readOnly = true,
					  value = "The order in which the rules get executed on transactions."//
							  + "

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

	@ApiModelProperty(readOnly = true,
					  value = "Details of rules. "//
							  + "

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

	@ApiModelProperty(readOnly = true,
					  value = "The level of the category for which the rule is created."//
							  + "

"//
							  + "Applicable containers: creditCard, insurance, loan
"//
	)
	@JsonProperty("categoryLevelId")
	private Integer categoryLevelId;

	/**
	 * Details of rules. 

	 * 

	 * Applicable containers: creditCard, investment, insurance, loan

	 * 
	 * @return ruleClauses
	 */
	@JsonProperty("ruleClauses")
	public List getRuleClauses() {
		return ruleClauses == null ? null : Collections.unmodifiableList(ruleClauses);
	}

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

	 * 

	 * Applicable containers: creditCard, investment, insurance, loan

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

	/**
	 * Unique identifier of the user. 

	 * 

	 * Applicable containers: creditCard, investment, insurance, loan

	 * 
	 * @return memId
	 */
	public Long getMemId() {
		return memId;
	}

	/**
	 * Category id that is assigned to the transaction when the transaction matches the rule clause. This is the id
	 * field of the transaction category resource. 

	 * 

	 * Applicable containers: creditCard, investment, insurance, loan

	 * 
	 * @return transactionCategorisationId
	 */
	public Long getTransactionCategorisationId() {
		return transactionCategorisationId;
	}

	/**
	 * The order in which the rules get executed on transactions. 

	 * 

	 * Applicable containers: creditCard, investment, insurance, loan

	 * 
	 * @return rulePriority
	 */
	public Integer getRulePriority() {
		return rulePriority;
	}

	/**
	 * The level of the category for which the rule is created. 

	 * 

	 * Applicable containers: creditCard, insurance, loan

	 * 
	 * @return categoryLevelId
	 */
	public Integer getCategoryLevelId() {
		return categoryLevelId;
	}

	@Override
	public String toString() {
		return "TransactionCategorizationRule [userDefinedRuleId=" + userDefinedRuleId + ", memId=" + memId
				+ ", transactionCategorisationId=" + transactionCategorisationId + ", rulePriority=" + rulePriority
				+ ", ruleClauses=" + ruleClauses + ", categoryLevelId=" + categoryLevelId + "]";
	}
}