DataObjectReferencePath Class

A DataObjectReferencePath represents a path from one or more source data objects to a number of target data objects. A path is comprised of a fragments each denoted by a reference property. Each path fragment can be either a forward or a backwards reference.

Inheritance Hierarchy

SystemObject
Omada.OE.ModelDataObjectReferencePath

Namespace: Omada.OE.Model
Assembly: Omada.OE.Model (in Omada.OE.Model.dll) Version: 15.0.0.0

Syntax

Copy

[SerializableAttribute]
public class DataObjectReferencePath

The DataObjectReferencePath type exposes the following members.

Constructors

	Name	Description
	DataObjectReferencePath	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.

Top

Properties

	Name	Description
	Fragments	Contains a collection of DataObjectReferencePathFragment objects

Top

Methods

	Name	Description
	GetIdCacheKey	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.
	IsValid	Returns whether a reference path is valid.
	Parse(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.
	Parse(String, String)	Parses ReferencePath in a string representation and returns the equivalent object representation.
	StripFirstFragment	Removes the first fragment of the reference path.
	ToString	Returns the string representation of the reference path. (Overrides ObjectToString.)

Top

Fields

	Name	Description
	DisplayFormat	Contains a display format used to obtain textual values of the data objects found using the reference path. 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]). Fixed fields must be stated by their name enclosed in square brackets (example: [Assignee]). Example: "His name is: [FNAME] [LNAME]" DisplayFormat can be null in which case the display names of the data objects found using the reference path are used.
	SystemNameAndResourceTypeNameRegExp	The fragment of a reference path in between "/" (forward), "\" (backward), ":[display name format]" and "{" (filter expression)

Top

Extension Methods

	Name	Description
	ToBool	Converts object to boolean. (Defined by ObjectExtensions.)
	ToDateTime	Converts object to DateTime. (Defined by ObjectExtensions.)
	ToInt	Converts object to integer. (Defined by ObjectExtensions.)

Top

Reference

Omada.OE.Model Namespace