🔍 Code Extractor

ReorderingRule is a class representing SharePoint search result reordering rules, inheriting from ClientValue to provide information about how search results should be reordered when specific conditions are met.

Purpose

This class serves as a data model for SharePoint Client Search Query reordering rules. It encapsulates the configuration and metadata needed to define how search results should be reordered based on certain conditions. The class is part of the Office365 SharePoint Client library and is used to interact with SharePoint's search query reordering functionality. It inherits from ClientValue, which likely provides serialization and client-server communication capabilities for SharePoint API interactions.

Source Code

class ReorderingRule(ClientValue):
    """The ReorderingRule type contains information about how search results SHOULD be reordered if they met the
    condition."""

    @property
    def entity_type_name(self):
        return "Microsoft.SharePoint.Client.Search.Query.ReorderingRule"

Parameters

Parameter Details

__init__: The constructor parameters are not explicitly defined in this code snippet. As it inherits from ClientValue, it likely accepts parameters defined by the parent class constructor. Typically, ClientValue-based classes accept property dictionaries or keyword arguments that map to SharePoint entity properties.

Return Value

Instantiating this class returns a ReorderingRule object that represents a SharePoint search reordering rule. The entity_type_name property returns the string 'Microsoft.SharePoint.Client.Search.Query.ReorderingRule', which identifies the SharePoint entity type for API communication.

Class Interface

Methods

Dependencies

• office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.sharepoint.client.search.query.reordering_rule import ReorderingRule

Usage Example

from office365.runtime.client_value import ClientValue
from office365.sharepoint.client.search.query.reordering_rule import ReorderingRule

# Instantiate a ReorderingRule object
reordering_rule = ReorderingRule()

# Access the entity type name
entity_type = reordering_rule.entity_type_name
print(entity_type)  # Output: Microsoft.SharePoint.Client.Search.Query.ReorderingRule

# Typically used within SharePoint search query context
# Example with search query (pseudo-code):
# search_query = SearchQuery()
# search_query.reordering_rules.add(reordering_rule)
# results = context.execute_query()

Best Practices

• This class is designed to be used within the Office365 SharePoint Client library context and should be instantiated as part of search query operations
• The class inherits from ClientValue, which handles serialization for SharePoint API communication - do not manually serialize instances
• The entity_type_name property is read-only and should not be modified as it identifies the SharePoint entity type
• Typically used in conjunction with SearchQuery objects to configure search result reordering behavior
• Ensure proper SharePoint authentication context is established before using this class in API operations
• This is a lightweight data model class with minimal state - instances can be created as needed without significant overhead

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class ReorderingRuleCollection 85.0% similar

  A SharePoint entity class that represents a collection of reordering rules for search results, inheriting from the Entity base class.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/reordering_rule_collection.py

• class PromotedResultQueryRule 69.6% similar

  Represents a promoted result query rule in SharePoint Search, containing properties that describe promoted search results for a tenant, Search Service Application, or site collection.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/promoted_result_query_rule.py

• class Sort 68.6% similar

  A class representing sort criteria for SharePoint search results, specifying which property to sort on and the sort direction.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/query/sort/sort.py

• class RefinementResults 66.5% similar

  A data class representing refinement results from a SharePoint search query, containing layout templates, refiners, and result metadata.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/refinement_results.py

• class SPListRule 64.9% similar

  SPListRule is a minimal class that inherits from ClientValue, representing a SharePoint list rule entity in the Office365 API.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/lists/rule.py