2.2.4.23 RuleInfo

  • Article

Namespace: http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration

The RuleInfo complex type contains information about a search scope rule.

 <xs:complexType name="RuleInfo">
   <xs:sequence>
     <xs:element minOccurs="0" name="FilterBehavior" type="tns:ScopeRuleFilterBehavior"/>
     <xs:element minOccurs="0" name="Id" type="xs:int"/>
     <xs:element minOccurs="0" name="IsDeleted" type="xs:boolean"/>
     <xs:element minOccurs="0" name="ManagedProperty" nillable="true" type="tns:ManagedPropertyInfo"/>
     <xs:element minOccurs="0" name="RuleType" type="tns:ScopeRuleType"/>
     <xs:element minOccurs="0" name="UrlRuleType" type="tns:UrlScopeRuleType"/>
     <xs:element minOccurs="0" name="UserValue" nillable="true" type="xs:string"/>
   </xs:sequence>
 </xs:complexType>

FilterBehavior: The filter behavior of the search scope rule. The value MUST be of ScopeRuleFilterBehavior data type, as specified in section 2.2.5.11.

Id: The unique identifier of the search scope rule.

IsDeleted: Specifies whether the search scope rule is defined in the protocol server. A value of "true" indicates that the search scope rule is not defined on the protocol server. A value of "false" indicates that the search scope rule is defined in the protocol server.

ManagedProperty: The managed property to be used in the search scope rule. The value MUST be a ManagedPropertyInfo data type, as specified in section 2.2.4.22, if the RuleType element is set to "ScopeRuleType.PropertyQuery", as specified in section 2.2.5.12. The value MUST NOT be present if the RuleType element is set to a value other than "ScopeRuleType.PropertyQuery".

RuleType: The type of the search scope rule. The value MUST be a ScopeRuleType data type, as specified in section 2.2.5.12. If the RuleType is set to "ScopeRuleType.AllContent", elements other than Id and IsDeleted of RuleInfo MUST be ignored. If the RuleType value is set to "ScopeRuleType.Url", elements other than Id, IsDeleted, FilterBehavior, UrlRuleType and UserValue on RuleInfo MUST be ignored. If the RuleType value is set to "ScopeRuleType.PropertyQuery", elements other than Id, IsDeleted, FilterBehavior, ManagedProperty and UserValue of RuleInfo MUST be ignored.

UrlRuleType: The URL type of the search scope rule. The value MUST be a UrlScopeRuleType data type, as specified in section 2.2.5.15.

UserValue: The search scope rule value used by the search scope rule. The value MUST be less than or equal to 2048 characters in length.