Optional keyValuePairs: KeyValuePair[]Utility function to check if the composite key has any values set
Static DefaultDefault delimiter for separating fields in a string that represents a key value pair within the composite key
Static DefaultDefault delimiter for separating values from field names in a string that represents a key value pair within the composite key
Utility function to return a copy of the CompositeKey with the Value properties as string
a copy of the KeyValuePairs array but with the Value properties as string
Utility function to compare this composite key to another
the composite key to compare against
true if the primary key values are the same, false if they are different
Utility function to compare the key primary key of this object to another sets to see if they are the same or not
the primary key values to compare against
true if the primary key values are the same, false if they are different
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.
Loads the KeyValuePairs from a list of strings in the format "FieldName=Value"
the list of strings to load from
Optional delimiter: stringthe delimiter to use between the field name and value. Defaults to '='
["ID=1", "Name=John"]
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.
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 '|'
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
Optional segment: stringUtility function to return a string representation of the composite key in the format "FieldName=Value AND FieldName=Value"
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"
a string representation of the composite key in the format "FieldName=Value AND FieldName=Value"
"ID=1 AND Name='John'"
Helper method to check if the underlying key value pairs are valid or not i.e. if any of the key value pairs are null or undefined
Optional entity: EntityInfoIf provided, this method will validate that the composite key is valid for the given entity as a primary key or alternate key.
If set to true, and entity is provided, this method will validate that the composite key is valid as the primary key for the given entity.
true if all key value pairs are valid, false if any are null or undefined
a copy of the KeyValuePairs array but with the Value properties as type string
Static FromIDMany entities have a single primary key field called ID, this utility method allows you to create a CompositeKey from just that ID value.
Static FromStatic factory method to create a CompositeKey from a single key value pair.
Static FromStatic factory method to create a CompositeKey from an array of key value pairs. Mirrors the constructor but allows for a more explicit creation of a CompositeKey from an array of KeyValuePair objects.
Static FromCreates a CompositeKey from a simple object where the keys are the field names and the values are the values.
Composite keys are used to represent database keys and can include one or more key value pairs.