The OFS enumeration is used to determine the status of a field in a search session. The enumeration contains:
|
Value |
Description |
|---|---|
|
OFSSubFieldNoInfo |
This is the default field status of all validating fields in the OptimaSearchSession before any searches are performed on them. (A validating field is one that has reference data available.) All validating fields will have this status after the OptimaSearchSession it is initialized by a call to InitSession. A field can also be reset to this state by a call to ClearField. |
|
OFSNoInfo |
Obsolete. |
|
OFSOutOfContext |
Following a call to GetAlterntives, an alternative with a status of OutOfContext signifies a result that matches the search string supplied in the OptimaSearchSession for the field (specified in the FieldNumber parameter of GetAlternatives), but is out of context with the other committed fields in the search session. |
|
OFSInContext |
Following a call to GetAlterntives, an alternative with a status of InContext signifies a result that matches the search string supplied in the OptimaSearchSession for the requested field (specified in the FieldNumber parameter of GetAlternatives), and is also in context with the other committed fields in the search session. |
|
OFSCommitted |
A field will have this status once it is committed. It may be committed explicitly, by calling CommitField and specifying an alternative returned from GetAlternatives, or committed implicitly, when the action of committing a different field means that there is then only one possible value for a different field. |
|
OFSNonValidating |
Non-validating fields (no reference data available) will always have this status. |
|
OFSUnused |
Obsolete. |
|
OFSNumStatusesPlusOne |
For internal use only. |