Skip to content

Commit

Permalink
[Automated] Generate Apex Docs (#163)
Browse files Browse the repository at this point in the history
Co-authored-by: GitHub Action Bot <action@github.com>
  • Loading branch information
moxygenbot[bot] and actions-user authored Jan 17, 2025
1 parent 7bc38b6 commit 57f78d5
Show file tree
Hide file tree
Showing 3 changed files with 200 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -471,6 +471,10 @@ Comparable class for NEXT_MONTH

Comparable class for NEXT_N_DAYS

### [NextNFiscalYearsComparable](uncategorized/NextNFiscalYearsComparable.md)

Compare the date field value with the NEXT_N_FISCAL_YEARS:N token

### [NextNQuartersComparable](uncategorized/NextNQuartersComparable.md)

Comparable for the NEXT_N_QUARTERS token
Expand Down
184 changes: 184 additions & 0 deletions docs/uncategorized/NextNFiscalYearsComparable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
# NextNFiscalYearsComparable Class

Compare the date field value with the NEXT_N_FISCAL_YEARS:N token

**Since**

1/11/2025

**Author** Zackary Frazier

**Inheritance**

[DateLiteralComparable](DateLiteralComparable.md)

## Properties
### `token`

*Inherited*

The token for the date literal

#### Signature
```apex
public token
```

#### Type
String

## Methods
### `isEqual(fieldValue)`

*Inherited*

Whether the date literal is equal to the field value

#### Signature
```apex
public virtual Boolean isEqual(DateTime fieldValue)
```

#### Parameters
| Name | Type | Description |
|------|------|-------------|
| fieldValue | DateTime | `DateTime` |

#### Return Type
**Boolean**

,[object Object]

---

### `isGreaterThan(fieldValue)`

Check if the fieldValue is greater than the NEXT_N_FISCAL_YEARS:N token

#### Signature
```apex
public override Boolean isGreaterThan(Datetime fieldValue)
```

#### Parameters
| Name | Type | Description |
|------|------|-------------|
| fieldValue | Datetime | Datetime or Date to be compared |

#### Return Type
**Boolean**

Whether fieldValue is greater than the NEXT_N_FISCAL_YEARS:N token

---

### `isGreaterThanOrEqual(fieldValue)`

*Inherited*

Whether the date literal is greater than or equal to the field value

#### Signature
```apex
public Boolean isGreaterThanOrEqual(DateTime fieldValue)
```

#### Parameters
| Name | Type | Description |
|------|------|-------------|
| fieldValue | DateTime | `DateTime` |

#### Return Type
**Boolean**

,[object Object]

---

### `isLessThan(fieldValue)`

Check if the fieldValue is less than the NEXT_N_FISCAL_YEARS:N token

#### Signature
```apex
public override Boolean isLessThan(Datetime fieldValue)
```

#### Parameters
| Name | Type | Description |
|------|------|-------------|
| fieldValue | Datetime | Datetime or Date to be compared |

#### Return Type
**Boolean**

Whether fieldValue is less than the NEXT_N_FISCAL_YEARS:N token

---

### `isLessThanOrEqual(fieldValue)`

*Inherited*

Whether the date literal is less than or equal to the field value

#### Signature
```apex
public Boolean isLessThanOrEqual(DateTime fieldValue)
```

#### Parameters
| Name | Type | Description |
|------|------|-------------|
| fieldValue | DateTime | `DateTime` |

#### Return Type
**Boolean**

,[object Object]

---

### `isNotEqual(fieldValue)`

*Inherited*

Whether the date literal is not equal to the field value

#### Signature
```apex
public Boolean isNotEqual(DateTime fieldValue)
```

#### Parameters
| Name | Type | Description |
|------|------|-------------|
| fieldValue | DateTime | `DateTime` |

#### Return Type
**Boolean**

,[object Object]

---

### `withToken(token)`

*Inherited*

Sets the token for the date literal

#### Signature
```apex
public DateLiteralComparable withToken(String token)
```

#### Parameters
| Name | Type | Description |
|------|------|-------------|
| token | String | `String` |

#### Return Type
**[DateLiteralComparable](DateLiteralComparable.md)**

,[object Object]
12 changes: 12 additions & 0 deletions docs/uncategorized/Token.md
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,18 @@ String

---

### `NEXT_N_FISCAL_YEARS`

#### Signature
```apex
public final static NEXT_N_FISCAL_YEARS
```

#### Type
String

---

### `NEXT_N_QUARTERS_LITERAL`

#### Signature
Expand Down

0 comments on commit 57f78d5

Please sign in to comment.