LookupType
This enumeration defines the available search modes for identifying entities, allowing lookups to be performed by name, by alias, or across both fields simultaneously.
Attributes
| Attribute | Type | Description |
|---|---|---|
| Name | integer = 1 | Specifies that the lookup operation should only search by the primary name field. |
| Alias | integer = 2 | Specifies that the lookup operation should only search by the alternative alias field. |
| Both | integer = 3 | Specifies that the lookup operation should search across both the primary name and alias fields. |
Methods
Name()
def Name() - > [LookupType](lookuptype.md?sid=lookup_key_lookuptype)
Specifies that the lookup should be performed using only the primary name of the entity.
Returns
| Type | Description |
|---|---|
[LookupType](lookuptype.md?sid=lookup_key_lookuptype) | A LookupType instance representing the Name variant. |
Alias()
def Alias() - > [LookupType](lookuptype.md?sid=lookup_key_lookuptype)
Specifies that the lookup should be performed using only the alternative alias of the entity.
Returns
| Type | Description |
|---|---|
[LookupType](lookuptype.md?sid=lookup_key_lookuptype) | A LookupType instance representing the Alias variant. |
Both()
def Both() - > [LookupType](lookuptype.md?sid=lookup_key_lookuptype)
Specifies that the lookup should be performed using both the primary name and any associated aliases.
Returns
| Type | Description |
|---|---|
[LookupType](lookuptype.md?sid=lookup_key_lookuptype) | A LookupType instance representing the Both variant. |