java.lang.Object
- com.ellucian.generated.eedm.contribution_calculation_rules.v8_0.ContributionCalculationRules

@Generated("jsonschema2pojo")
public class ContributionCalculationRules
extends Object

Contribution Calculation Rules

Rules used in calculating contributions.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ContributionCalculationRules.CategoryGroupInclusion`	Category Group Inclusion
`static class`	`ContributionCalculationRules.CategoryInclusion`	Category Inclusion

Field Summary

Fields
Modifier and Type	Field	Description
`private List<Category>`	`categories`	Categories
`private ContributionCalculationRules.CategoryGroupInclusion`	`categoryGroupInclusion`	Category Group Inclusion
`private List<CategoryGroup>`	`categoryGroups`	Category Groups
`private ContributionCalculationRules.CategoryInclusion`	`categoryInclusion`	Category Inclusion
`private List<ContributionType>`	`contributionTypes`	Contribution Type
`private List<CreditType>`	`creditTypes`	Credit Types
`private String`	`description`	Description
`private String`	`id`	ID
`private Metadata`	`metadata`	Metadata
`private String`	`title`	Title

Constructor Summary

Constructors
Constructor Description

ContributionCalculationRules()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object other)`
`List<Category>`	`getCategories()`	Categories
`ContributionCalculationRules.CategoryGroupInclusion`	`getCategoryGroupInclusion()`	Category Group Inclusion
`List<CategoryGroup>`	`getCategoryGroups()`	Category Groups
`ContributionCalculationRules.CategoryInclusion`	`getCategoryInclusion()`	Category Inclusion
`List<ContributionType>`	`getContributionTypes()`	Contribution Type
`List<CreditType>`	`getCreditTypes()`	Credit Types
`String`	`getDescription()`	Description
`String`	`getId()`	ID
`Metadata`	`getMetadata()`	Metadata
`String`	`getTitle()`	Title
`int`	`hashCode()`
`void`	`setCategories(List<Category> categories)`	Categories
`void`	`setCategoryGroupInclusion(ContributionCalculationRules.CategoryGroupInclusion categoryGroupInclusion)`	Category Group Inclusion
`void`	`setCategoryGroups(List<CategoryGroup> categoryGroups)`	Category Groups
`void`	`setCategoryInclusion(ContributionCalculationRules.CategoryInclusion categoryInclusion)`	Category Inclusion
`void`	`setContributionTypes(List<ContributionType> contributionTypes)`	Contribution Type
`void`	`setCreditTypes(List<CreditType> creditTypes)`	Credit Types
`void`	`setDescription(String description)`	Description
`void`	`setId(String id)`	ID
`void`	`setMetadata(Metadata metadata)`	Metadata
`void`	`setTitle(String title)`	Title
`String`	`toString()`
`ContributionCalculationRules`	`withCategories(List<Category> categories)`
`ContributionCalculationRules`	`withCategoryGroupInclusion(ContributionCalculationRules.CategoryGroupInclusion categoryGroupInclusion)`
`ContributionCalculationRules`	`withCategoryGroups(List<CategoryGroup> categoryGroups)`
`ContributionCalculationRules`	`withCategoryInclusion(ContributionCalculationRules.CategoryInclusion categoryInclusion)`
`ContributionCalculationRules`	`withContributionTypes(List<ContributionType> contributionTypes)`
`ContributionCalculationRules`	`withCreditTypes(List<CreditType> creditTypes)`
`ContributionCalculationRules`	`withDescription(String description)`
`ContributionCalculationRules`	`withId(String id)`
`ContributionCalculationRules`	`withMetadata(Metadata metadata)`
`ContributionCalculationRules`	`withTitle(String title)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

metadata

@JsonPropertyDescription("Metadata about the JSON payload")
private Metadata metadata

Metadata

Metadata about the JSON payload

id

@JsonPropertyDescription("The global identifier of the contribution calculation rule.")
private String id

ID

The global identifier of the contribution calculation rule. (Required)

title

@JsonPropertyDescription("The full name of the contribution calculation rule.")
private String title

Title

The full name of the contribution calculation rule. (Required)

description

@JsonPropertyDescription("The description of the contribution calculation rule.")
private String description

Description

The description of the contribution calculation rule.

contributionTypes

@JsonPropertyDescription("The types of contribution that are applicable to the calculation rule. (eg: gift, pledge, recurringGift, etc)")
private List<ContributionType> contributionTypes

Contribution Type

The types of contribution that are applicable to the calculation rule. (eg: gift, pledge, recurringGift, etc)

creditTypes

@JsonPropertyDescription("The types of credit that are applicable to the calculation rule. (eg: legal, recognition, etc.)")
private List<CreditType> creditTypes

Credit Types

The types of credit that are applicable to the calculation rule. (eg: legal, recognition, etc.)

categoryInclusion

@JsonPropertyDescription("An indication if the specified categories are included or excluded in the calculation rule.")
private ContributionCalculationRules.CategoryInclusion categoryInclusion

Category Inclusion

An indication if the specified categories are included or excluded in the calculation rule.

Category Group Inclusion

An indication if the specified category groups are included or excluded in the calculation rule.

categoryGroups

@JsonPropertyDescription("Contribution category groups to be included or excluded in the calculation rule.")
private List<CategoryGroup> categoryGroups

Category Groups

Contribution category groups to be included or excluded in the calculation rule.

Constructor Detail
- ContributionCalculationRules
```
public ContributionCalculationRules()
```

Method Detail
- getMetadata
```
public Metadata getMetadata()
```
  Metadata
  Metadata about the JSON payload
- setMetadata
```
public void setMetadata(Metadata metadata)
```
  Metadata
  Metadata about the JSON payload
- withMetadata
```
public ContributionCalculationRules withMetadata(Metadata metadata)
```
- getId
```
public String getId()
```
  ID
  The global identifier of the contribution calculation rule. (Required)
- setId
```
public void setId(String id)
```
  ID
  The global identifier of the contribution calculation rule. (Required)
- withId
```
public ContributionCalculationRules withId(String id)
```
- getTitle
```
public String getTitle()
```
  Title
  The full name of the contribution calculation rule. (Required)
- setTitle
```
public void setTitle(String title)
```
  Title
  The full name of the contribution calculation rule. (Required)
- withTitle
```
public ContributionCalculationRules withTitle(String title)
```
- getDescription
```
public String getDescription()
```
  Description
  The description of the contribution calculation rule.
- setDescription
```
public void setDescription(String description)
```
  Description
  The description of the contribution calculation rule.
- withDescription
```
public ContributionCalculationRules withDescription(String description)
```
- getContributionTypes
```
public List<ContributionType> getContributionTypes()
```
  Contribution Type
  The types of contribution that are applicable to the calculation rule. (eg: gift, pledge, recurringGift, etc)
- setContributionTypes
```
public void setContributionTypes(List<ContributionType> contributionTypes)
```
  Contribution Type
  The types of contribution that are applicable to the calculation rule. (eg: gift, pledge, recurringGift, etc)
- withContributionTypes
```
public ContributionCalculationRules withContributionTypes(List<ContributionType> contributionTypes)
```
- getCreditTypes
```
public List<CreditType> getCreditTypes()
```
  Credit Types
  The types of credit that are applicable to the calculation rule. (eg: legal, recognition, etc.)
- setCreditTypes
```
public void setCreditTypes(List<CreditType> creditTypes)
```
  Credit Types
  The types of credit that are applicable to the calculation rule. (eg: legal, recognition, etc.)
- withCreditTypes
```
public ContributionCalculationRules withCreditTypes(List<CreditType> creditTypes)
```
- getCategoryInclusion
```
public ContributionCalculationRules.CategoryInclusion getCategoryInclusion()
```
  Category Inclusion
  An indication if the specified categories are included or excluded in the calculation rule.
- setCategoryInclusion
```
public void setCategoryInclusion(ContributionCalculationRules.CategoryInclusion categoryInclusion)
```
  Category Inclusion
  An indication if the specified categories are included or excluded in the calculation rule.
- withCategoryInclusion
```
public ContributionCalculationRules withCategoryInclusion(ContributionCalculationRules.CategoryInclusion categoryInclusion)
```
- getCategories
```
public List<Category> getCategories()
```
  Categories
  Contribution categories to be included or excluded in the calculation rule.
- setCategories
```
public void setCategories(List<Category> categories)
```
  Categories
  Contribution categories to be included or excluded in the calculation rule.
- withCategories
```
public ContributionCalculationRules withCategories(List<Category> categories)
```
- getCategoryGroupInclusion
```
public ContributionCalculationRules.CategoryGroupInclusion getCategoryGroupInclusion()
```
  Category Group Inclusion
  An indication if the specified category groups are included or excluded in the calculation rule.
- setCategoryGroupInclusion
```
public void setCategoryGroupInclusion(ContributionCalculationRules.CategoryGroupInclusion categoryGroupInclusion)
```
  Category Group Inclusion
  An indication if the specified category groups are included or excluded in the calculation rule.
- withCategoryGroupInclusion
```
public ContributionCalculationRules withCategoryGroupInclusion(ContributionCalculationRules.CategoryGroupInclusion categoryGroupInclusion)
```
- getCategoryGroups
```
public List<CategoryGroup> getCategoryGroups()
```
  Category Groups
  Contribution category groups to be included or excluded in the calculation rule.
- setCategoryGroups
```
public void setCategoryGroups(List<CategoryGroup> categoryGroups)
```
  Category Groups
  Contribution category groups to be included or excluded in the calculation rule.
- withCategoryGroups
```
public ContributionCalculationRules withCategoryGroups(List<CategoryGroup> categoryGroups)
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- equals
```
public boolean equals(Object other)
```
  Overrides:
  
  equals in class Object

Class ContributionCalculationRules

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

metadata

id

title

description

contributionTypes

creditTypes

categoryInclusion

categories

categoryGroupInclusion

categoryGroups

Constructor Detail

ContributionCalculationRules

Method Detail

getMetadata

setMetadata

withMetadata

getId

setId

withId

getTitle

setTitle

withTitle

getDescription

setDescription

withDescription

getContributionTypes

setContributionTypes

withContributionTypes

getCreditTypes

setCreditTypes

withCreditTypes

getCategoryInclusion

setCategoryInclusion

withCategoryInclusion

getCategories

setCategories

withCategories

getCategoryGroupInclusion

setCategoryGroupInclusion

withCategoryGroupInclusion

getCategoryGroups

setCategoryGroups

withCategoryGroups

toString

hashCode

equals