Click or drag to resize

DataObjectReferencePath Methods

The DataObjectReferencePath type exposes the following members.

Methods
  NameDescription
Public methodGetIdCacheKey
Returns a string cache key for caching the id yield of the reference path. It is similar to the path but excludes the display name format.
Public methodStatic memberIsValid
Returns whether a reference path is valid.
Public methodStatic memberCode exampleParse(String)
Parses a reference path.

A reference path consists of system names of reference properties seperated by slash or backslash. Certain fixed fields are also supported including among others "PROCESS" and "TARGET". Slash (/) indicates a forward reference. Backslash (\) indicates a backwards reference.

Each reference property system name can optionally be postfixed with filter expressions in {}.

The entire reference path can optionally be postfixed with a display format on the format [:][display format]. The display format may contain fixed text and variable text in the form of properties and fixed fields. Properties must be stated by their system name enclosed in square brackets (example: [NAME]).

Throws an exception if the path can't be parsed.

Public methodStatic memberParse(String, String)
Parses ReferencePath in a string representation and returns the equivalent object representation.
Public methodStripFirstFragment
Removes the first fragment of the reference path.
Public methodToString
Returns the string representation of the reference path.
(Overrides ObjectToString.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBool
Converts object to boolean.
(Defined by ObjectExtensions.)
Public Extension MethodToDateTime
Converts object to DateTime.
(Defined by ObjectExtensions.)
Public Extension MethodToInt
Converts object to integer.
(Defined by ObjectExtensions.)
Top
See Also