2.2.4.24 ScopeInfo

  • Article

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

The ScopeInfo complex type contains information about a search scope.

 <xs:complexType name="ScopeInfo">
   <xs:sequence>
     <xs:element minOccurs="0" name="AlternateResultsPage" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="CompilationState" type="tns:ScopeCompilationState"/>
     <xs:element minOccurs="0" name="CompilationType" type="tns:ScopeCompilationType"/>
     <xs:element minOccurs="0" name="ConsumerName" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="DisplayInAdminUI" type="xs:boolean"/>
     <xs:element minOccurs="0" name="Filter" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="Id" type="xs:int"/>
     <xs:element minOccurs="0" name="IsDeleted" type="xs:boolean"/>
     <xs:element minOccurs="0" name="LastCompilationTime" type="xs:dateTime"/>
     <xs:element minOccurs="0" name="LastModifiedBy" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="LastModifiedTime" type="xs:dateTime"/>
     <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string"/>
     <xs:element minOccurs="0" name="SiteUrl" nillable="true" type="xs:string"/>
   </xs:sequence>
 </xs:complexType>

AlternateResultsPage:  Specifies the URL of the alternate results page of the search scope. MUST NOT be present if an alternate results page URL is not specified for the search scope. The length of this string MUST be less than or equal to 2048.

CompilationState: Specifies the Compilation State of the search scope. MUST be a ScopeCompilationState data type as specified in section 2.2.5.9.        

CompilationType: Specifies the Compilation Type of the search scope. MUST be a ScopeCompilationType data type as specified in section 2.2.5.10.

ConsumerName: Specifies the name of the site collection that is defined as consumer of the search scope. For a shared search scope this MUST be equal to String.Empty.

For a local search scope this MUST be equal to the name of the site collection that created the search scope. For a local search scope the length of this string MUST be greater than or equal to 1 and less than or equal to 60.

Description: Specifies the description of the search scope. The length of this string MUST be less than or equal to 300.

DisplayInAdminUI: Specifies whether the search scope is displayed in the Administration user interface. A value of "true" indicates that the search scope is displayed in the Administration user interface; a value of "false" indicates that the search scope is not displayed in the Administration user interface.

Filter: Reserved. MUST be ignored on receipt.

Id: Specifies the unique identifier of the search scope. MUST be positive.

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

LastCompilationTime: Specifies the date and time, in Coordinated Universal Time (UTC) format, when the search scope was last compiled.

LastModifiedBy: Specifies the name of the user who last modified the search scope. The length of this string MUST be less than or equal to 60. MUST retain only the first 60 characters of the name if the name is longer than 60 characters.

LastModifiedTime: Specifies the date and time, in UTC format, when the search scope was last modified.

Name: Specifies the name of the search scope. The length of this string MUST be greater than or equal to 1 and less than or equal to 60.

SiteUrl: Specifies the URL of the consumer specified in ConsumerName. The length of this string MUST be less than or equal to 2048.