Foundations Apex API Developer Reference

fferpcore.Path2

global with sharing class Path2

Represent a path through a data structure.

Enums

ElementType

Type of element in an ErrorEvent path.

Value Description
FIELD A single field on a Record.
LOOKUP A lookup key.
CHILDREN A child relationship key.
LISTINDEX An index in a RecordList.

TargetType

Target of a Path.

Value Description
RECORD A single Record.
RECORD_LIST All records in a RecordList.
FIELD A field in a single Record.
LOOKUP A lookup on a Record.

Methods

newFieldElement

global static fferpcore.Path2.Element newFieldElement(String key)

Create a field element using a key.

Input Parameters

Name Type Description
key String The key corresponding to the field.

Return Value

A field element with the specified key.

Path2

global Path2(fferpcore.Path2.Element rootElement)

getFirstElement

global fferpcore.Path2.Element getFirstElement()

getTargetType

global fferpcore.Path2.TargetType getTargetType()

isDeletedItem

global Boolean isDeletedItem()

Return Value

True if this path represents a deleted item.

toString

global override String toString()

toString is provided for debugging purposes.

Return Value

A string representation of this path, including the class name for debugging.

equals

global Boolean equals(Object other)

hashCode

global Integer hashCode()

fferpcore.Path2.Element

global interface Element

Section of the path in an ErrorEvent.

Methods

getPathElementType

Path2.ElementType getPathElementType()

Return Value

The type of the PathElement.

getPathElementKey

String getPathElementKey()

Return Value

The key associated with the Path2.Element.

getNextPathElement

Path2.Element getNextPathElement()

Return Value

The next Path2.Element in the path, or null if this is the last element.

getElementAsString

String getElementAsString()

Return Value

A string representation of this element.

isDeletedItem

Boolean isDeletedItem()

Does this path represent something that is no longer there? For example something that was a lookup, or a deleted child from a list. Systems should preserve keys, so list keys would include deleted items in place.

Return Value

fferpcore.Path2.IndexElement

global interface IndexElement extends Path2.Element

Section of the path in an ErrorEvent that uses an index.

This class extends fferpcore.Path2.Element

Methods

getPathElementIndex

Integer getPathElementIndex()

Return Value

The index associated with the PathElement. This index includes deleted items, so may differ from the index in the live list.

© Copyright 2009–2021 FinancialForce.com, inc. All rights reserved. Various trademarks held by their respective owners.