-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Automated] Generate Apex Docs (#163)
Co-authored-by: GitHub Action Bot <action@github.com>
- Loading branch information
1 parent
7bc38b6
commit 57f78d5
Showing
3 changed files
with
200 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters