IAdmReportGeneratorSearch

The IAdmReportGeneratorSearch interface represents a generator used to build reports by performing a directory search.

Inheritance: IAdmReportGenerator

Methods

Properties

  • Property

  • Description

  • Conditions

  • Gets the conditions to include or exclude objects from a report.

  • IncludeDeletedObjects

  • Gets or sets a value indicating whether search results must include deleted objects.

Details

GetCriteria()

Returns the IAdmCriteria interface that represents the search criteria for including objects into a report.

IAdmCriteria GetCriteria()

SetCriteria()

Sets the search criteria for including objects into a report.

void SetCriteria(IAdmCriteria criteria)

Parameters

The criteria parameter specifies the search criteria for including objects into a report.

ResolveValueReferencesInCriteria()

Returns the given search criteria with value references replaced with values of corresponding properties of the user, for which a report is generated.

IAdmCriteria ResolveValueReferencesInCriteria(IAdmReportArguments arguments,
                                              IAdmCriteria criteria,
                                              out string[] warnings)

Parameters

  • arguments - Specifies the arguments for report generation.
  • criteria - Specifies the search criteria.
  • warnings - An output (OUT) parameter that returns an array of warnings issued while replacing value references.

Conditions

Gets the conditions to include or exclude objects from a report.

Examples

The following code sample adds the If account is inactive for more than 20 weeks condition to the report generator. Objects that meet the condition are included into a report.

PowerShell
# The $reportGenerator variable represents the report generator
                    
$reportGenerator.Conditions.Exclude = $false

$reportConditionSet = $reportGenerator.Conditions.CreateConditionSet()
$reportCondition = $reportConditionSet.CreateCondition("adm-InactiveAccountCondition")
$reportCondition.PeriodOperator = "ADM_EXPIRATIONCOMPARISONOPERATOR_MORETHAN"
$reportCondition.PeriodValue = "20"
$reportConditionSet.Conditions = @($reportCondition)
$reportGenerator.Conditions.Conditions = @($reportConditionSet)
C#
using Softerra.Adaxes.Interop.Adsi;
using Softerra.Adaxes.Interop.Adsi.BusinessRules;

class Program
{
    static void Main(string[] args)
    {
        // The reportGenerator variable represents the report generator

        reportGenerator.Conditions.Exclude = false;

        IAdmConditionSet reportConditionSet = reportGenerator.Conditions.CreateConditionSet();
        IAdmInactiveAccountCondition reportCondition = 
            (IAdmInactiveAccountCondition)reportConditionSet.CreateCondition(
            "adm-InactiveAccountCondition");
        reportCondition.PeriodOperator = 
            ADM_PERIODCOMPARISONOPERATOR_ENUM.ADM_EXPIRATIONCOMPARISONOPERATOR_MORETHAN;
        reportCondition.PeriodValue = 20;
        reportConditionSet.Conditions = new IAdmCondition[] {reportCondition};
        reportGenerator.Conditions.Conditions = new IAdmConditionSet[] {reportConditionSet};
    }
}

IncludeDeletedObjects

Gets or sets a value indicating whether search results must include deleted objects.

  • Type:
  • bool
  • Access:
  • Read/Write

Requirements

Minimum required version: 2023

See also

© Softerra 2022. All rights reserved.
Send feedback