Home >	Contents >	Index >
Template Tag TOC  |   Alpha TOC  |   Tag Family TOC  |   Purpose TOC  |   Annotated TOC  |   Index

SEARCHSTATE.FINDCONSTRAINT

Checks a searchstate for a constraint to a specific attribute.

Syntax

<SEARCHSTATE.FINDCONSTRAINT
      NAME="ssname"
      [BUCKET="bucketname"]
      ATTRIBUTE="attribname"
      VARNAME="varname"/> 

Parameters

NAME (required)

Input parameter. Name of an object representing a searchstate.

BUCKET (optional)

Input parameter. Bucket name. If not specified, the attribute name is used. Use this parameter to indicate which constraint you need when the same attribute is used in multiple contstraints. A bucket is an alias and functions similar to an inner join in SQL; when you have multiple tables that have columns of the same name, you must specify the table name to indicate which column you are requesting.

ATTRIBUTE (required)

Input parameter. Name of the attribute to constrain.

VARNAME (required)

Input and output parameter. As input, name of a variable into which to write the constraint type on output. Note the variants below.

OBJVARNAME (required)

Name of an object to create with the contents of the nested constraint.

ATTRTYPEVARNAME (optional)

Name of a variable into which to write the attribute asset type name for the constraint.

ATTRVARNAME (optional)

Name of a variable into which to write the attribute name for the constraint.

LISTVARNAME (required)

Name of a variable into which to write the list of values for the attribute, if found. If not found, the variable is set to null. The list has a single column named value.

IMMEDIATEONLYVARNAME (optional)

Name of a variable into which to write the IMMEDIATEONLY constraint value.

CASEINSENSITIVEVARNAME (optional)

Name of a variable into which to write the CASEINSENSITIVE constraint value.

ATTRTYPEVARNAME (optional)

Name of a variable into which to write the attribute asset type name for the constraint.

ATTRVARNAME (optional)

Name of a variable into which to write the attribute name for the constraint.

EXPRESSIONVARNAME (optional)

Name of the variable into which to write the rich text expression.

PARSERVARNAME (optional)

Name of the variable into which to write the rich text parser name.

CONFIDENCEVARNAME (optional)

Name of the variable into which to write the confidence.

MAXCOUNTVARNAME (optional)

Name of the variable into which to write the max answers.

ATTRTYPEVARNAME (optional)

Name of a variable into which to write the attribute asset type name for the constraint.

ATTRVARNAME (optional)

Name of a variable into which to write the attribute name for the constraint.

LOWERVARNAME | LOWEREQUALVARNAME (required)

Name of the variable into which to write the lower constraint.

UPPERVARNAME | UPPEREQUALVARNAME (required)

Name of the variable into which to write the upper constraint.

IMMEDIATEONLYVARNAME (optional)

Name of the variable into which to write the IMMEDIATEONLY value constraint.

CASEINSENSITIVEVARNAME (optional)

Name of a variable into which to write the CASEINSENSITIVE constraint value.

Description

If found, data values about the constraint are returned.

errno

The possible values of errno include:

Value	Description
-10004	A required parameter is missing.
-13050	General error.

Example

This code creates an empty SEARCHSTATE and adds a range constraint. It then uses the SEARCHSTATE.FINDCONSTRAINT tag to retrieve various parameters set into the constraint earlier:

<SEARCHSTATE.CREATE NAME="ss" />
<SEARCHSTATE.ADDRANGECONSTRAINT NAME="ss" ATTRIBUTE="price" UPPER="3" LOWER="2"/>
<SEARCHSTATE.FINDCONSTRAINT NAME="ss" ATTRIBUTE="price" VARNAME="constrainttype" ATTRTYPEVARNAME="typename" ATTRVARNAME="attribute" UPPERVARNAME="upper" LOWERVARNAME="lowerequal"/>
<CSVAR NAME="constrainttype"/><br/>
<CSVAR NAME="typename"/><br/>
<CSVAR NAME="attribute"/><br/>
<CSVAR NAME="upper"/><br/>
<CSVAR NAME="lowerequal"/><br/>

See Also

SEARCHSTATE.CREATE
SEARCHSTATE.ADDSIMPLELIKECONSTRAINT
SEARCHSTATE.ADDSIMPLESTANDARDCONSTRAINT
SEARCHSTATE.ADDLIKECONSTRAINT
SEARCHSTATE.ADDSTANDARDCONSTRAINT
SEARCHSTATE.ADDRANGECONSTRAINT
SEARCHSTATE.ADDRICHTEXTCONSTRAINT
SEARCHSTATE.ADDNESTEDCONSTRAINT

		Home >	Contents >	Index >
	FatWire XML Tag Reference Copyright 2005 by FatWire Software All rights reserved.