Class FieldValueCollection

constructor

• new FieldValueCollection(keyValuePairs?): FieldValueCollection

• Parameters

  • Optional keyValuePairs: KeyValuePair[]

  Returns FieldValueCollection

KeyValuePairs

HasValue

• get HasValue(): boolean

• Utility function to check if the composite key has any values set

  Returns boolean

Static DefaultFieldDelimiter

• get DefaultFieldDelimiter(): string

• Default delimiter for separating fields in a string that represents a key value pair within the composite key

  Returns string

Static DefaultValueDelimiter

• get DefaultValueDelimiter(): string

• Default delimiter for separating values from field names in a string that represents a key value pair within the composite key

  Returns string

Copy

• Copy(): CompositeKey

• Utility function to return a copy of the CompositeKey with the Value properties as string

  Returns CompositeKey

  a copy of the KeyValuePairs array but with the Value properties as string

GetValueByFieldName

• GetValueByFieldName(fieldName): any

• returns the value of the key value pair for the specified field name

  Parameters

  • fieldName: string

    the field name to get the value for

  Returns any

  the value of the key value pair for the specified field name

GetValueByIndex

• GetValueByIndex(index): any

• returns the value of the key value pair at the specified index

  Parameters

  • index: number

    the index of the key value pair to get the value for

  Returns any

  the value of the key value pair at the specified index

LoadFromConcatenatedString

• LoadFromConcatenatedString(concatenatedString, fieldDelimiter?, valueDelimiter?): void

• Utility to load the object from a string representation of the key value pairs in the format "Field1|Value1||Field2|Value2" etc. The delimiters between the fields default to '||' and the values default to '|', but can be anything desired.

  Parameters

  • concatenatedString: string
  • fieldDelimiter: string = '||'
  • valueDelimiter: string = '|'

  Returns void

LoadFromEntityFields

• LoadFromEntityFields(fields): void

• Parameters

  • fields: EntityField[]

  Returns void

LoadFromEntityInfoAndRecord

• LoadFromEntityInfoAndRecord(entity, entityRecord): void

• Parameters

  • entity: EntityInfo
  • entityRecord: any

  Returns void

LoadFromList

• LoadFromList(list, delimiter?): void

• Loads the KeyValuePairs from a list of strings in the format "FieldName=Value"

  Parameters

  • list: string[]

    the list of strings to load from
  • Optional delimiter: string

    the delimiter to use between the field name and value. Defaults to '='

  Returns void

  Example

  ["ID=1", "Name=John"]
  Copy

LoadFromSimpleObject

• LoadFromSimpleObject(obj): void

• Loads from a simple object by extracting the key value pairs from the object

  Parameters

  • obj: any

  Returns void

LoadFromSingleKeyValuePair

• LoadFromSingleKeyValuePair(fieldName, value): void

• Loads the key from a single key value pair

  Parameters

  • fieldName: string
  • value: any

  Returns void

LoadFromURLSegment

• LoadFromURLSegment(entity, urlSegment): void

• Parses a provided url segment using the provided delimiter and loads the key value pairs from it. If the segment just contains a single value and no delimiter, it will assume the field name is the primary key field name of the entity and load that way.

  Parameters

  • entity: EntityInfo
  • urlSegment: string

  Returns void

SimpleLoadFromURLSegment

• SimpleLoadFromURLSegment(urlSegment): void

• Parses the provided routeSegment and assumes the field names are included in the segment

  Parameters

  • urlSegment: string

  Returns void

ToConcatenatedString

• ToConcatenatedString(fieldDelimiter?, valueDelimiter?): string

• Utility to generate a string representation of the key value pairs in the format "Field1|Value1||Field2|Value2" etc. The field delimiter defaults to '||' and the value delimiter defaults to '|'

  Parameters

  • fieldDelimiter: string = '||'
  • valueDelimiter: string = '|'

  Returns string

ToList

• ToList(delimiter?): string[]

• Parameters

  • Optional delimiter: string

    the delimiter to use between the field name and value. Defaults to '='

  Returns string[]

  the KeyValuePairs as a list of strings in the format "FieldName=Value"

  Example

  ["ID=1", "Name=John"]
  Copy

ToString

• ToString(useIsNull?): string

• Parameters

  • Optional useIsNull: boolean

    if true, will return "FieldName IS NULL" for any key value pair that has a null or undefined value

  Returns string

  a string representation of the primary key values in the format "FieldName=Value"

  Example

  "ID=1 AND Name=John"
  Copy

ToURLSegment

• ToURLSegment(segment?): string

• For URL segments, we use | and || as the standard delimiters for field and value respectively in order to avoid conflicts with the standard URL delimiters like = and &. This method converts the key value pairs to a URL segment

  Parameters

  • Optional segment: string

  Returns string

ToWhereClause

• ToWhereClause(useIsNull?, quoteStyle?): string

• Utility function to return a string representation of the composite key in the format "FieldName=Value AND FieldName=Value"

  Parameters

  • useIsNull: boolean = true

    if true, will return "FieldName IS NULL" for any key value pair that has a null or undefined value, if false, will return "FieldName=Value"
  • quoteStyle: "single" | "double" = 'single'

  Returns string

  a string representation of the composite key in the format "FieldName=Value AND FieldName=Value"

  Example

  "ID=1 AND Name='John'"
  Copy

Values

• Values(delimiter?): string

• Parameters

  • Optional delimiter: string

    the delimiter to use between the values. Defaults to ', '

  Returns string

  the value of each key value pair in the format "Value1, Value2, Value3"

  Example

  "1, John"
  Copy

ValuesAsString

• ValuesAsString(): KeyValuePair[]

• Returns KeyValuePair[]

  a copy of the KeyValuePairs array but with the Value properties as type string

Static FromObject

• FromObject(obj): FieldValueCollection

• Static helper method to instantiate a FieldValueCollection from a simple object

  Parameters

  • obj: any

  Returns FieldValueCollection