Wiki source code of GetTrkByKeyStatus
Last modified by Outhman Moustaghfir on 2024/02/26 17:12
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | == Overview == | ||
| 2 | |||
| 3 | The GetTrkByKeyStatus function is utilized to retrieve the TrkID of trackings based on specified key, value, and status criteria. This function enables the retrieval of tracking information tailored to specific conditions. | ||
| 4 | |||
| 5 | {{code language="XML"}} | ||
| 6 | GetTrkByKeyStatus(trackingType, key, value, status1, status2, ..., statusN) | ||
| 7 | |||
| 8 | {{/code}} | ||
| 9 | |||
| 10 | |||
| 11 | * **trackingType**: The type of tracking .**(Reaquired)** | ||
| 12 | * **key**: The key associated with the tracking.**(Reaquired)** | ||
| 13 | * **value**: The value of the specified key.**(Reaquired)** | ||
| 14 | * **status1, status2, ..., statusN**: Additional optional status parameters that filter the tracking. | ||
| 15 | |||
| 16 | === Parameters === | ||
| 17 | |||
| 18 | * **trackingType**: (Type: string) Identifies the type of tracking record. | ||
| 19 | * **key**: (Type: any) Represents the key associated with the tracking record. | ||
| 20 | * **value**: (Type: any) Specifies the value corresponding to the specified key. | ||
| 21 | * **status1, status2, ..., statusN**: (Type: string, Optional) Additional status parameters that narrow down the search based on the tracking record's status. | ||
| 22 | |||
| 23 | === Usage === | ||
| 24 | |||
| 25 | Example: | ||
| 26 | |||
| 27 | {{code language="XML"}} | ||
| 28 | <xsl:value-of select=" ixf:GetTrkByKeyStatus('SimpleTrackingType', 'Key', 'value', 'Available', 'Locked')"></xsl:value-of> | ||
| 29 | |||
| 30 | {{/code}} | ||
| 31 | |||
| 32 | |||
| 33 | This example retrieves the TrkID of tracking records of type 'SimpleTrackingType' with 'Key' as the key, 'value' with 'KeyThis example retrieves the TrkID of tracking records of type 'SimpleTrackingType as the associated value, and statuses 'Available' and 'Locked'. | ||
| 34 | |||
| 35 | === Note === | ||
| 36 | |||
| 37 | * After the third argument (value), subsequent arguments are treated as optional status parameters. | ||
| 38 | * The function returns the TrkID associated with the matching tracking records. | ||
| 39 | |||
| 40 | == Conclusion == | ||
| 41 | |||
| 42 | GetTrkByKeyStatus offers a versatile mechanism for fetching TrkID based on key, value, and optional status parameters, providing flexibility in tracking record retrieval. |