Table of Contents

Class ComplianceBenchmarkResultCollection

Namespace
CENTREL.XIA.Configuration.Types
Assembly
CENTREL.XIA.Configuration.Types.dll

Represents a collection of compliance benchmark results.

public class ComplianceBenchmarkResultCollection : Collection<ComplianceBenchmarkResult>, IList<ComplianceBenchmarkResult>, ICollection<ComplianceBenchmarkResult>, IList, ICollection, IReadOnlyList<ComplianceBenchmarkResult>, IReadOnlyCollection<ComplianceBenchmarkResult>, IEnumerable<ComplianceBenchmarkResult>, IEnumerable
Inheritance
ComplianceBenchmarkResultCollection
Implements
Inherited Members

Constructors

ComplianceBenchmarkResultCollection()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResultCollection class.

public ComplianceBenchmarkResultCollection()

Methods

Add(SerializableReferenceNumber, string, object, ComplianceBenchmarkResultType)

Adds a new result to the collection.

public ComplianceBenchmarkResult Add(SerializableReferenceNumber referenceNumber, string title, object configuredValue, ComplianceBenchmarkResultType resultType)

Parameters

referenceNumber SerializableReferenceNumber

The reference number for the result.

title string

The title for the result.

configuredValue object

The configured value at the time of the scan.

resultType ComplianceBenchmarkResultType

The result type.

Returns

ComplianceBenchmarkResult

The CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult that was added to the collection.

Add(SerializableReferenceNumber, string, object, bool)

Adds a new result to the collection.

public ComplianceBenchmarkResult Add(SerializableReferenceNumber referenceNumber, string title, object configuredValue, bool passCondition)

Parameters

referenceNumber SerializableReferenceNumber

The reference number for the result.

title string

The title for the result.

configuredValue object

The configured value at the time of the scan.

passCondition bool

A boolean value that indicates whether the success condition was met.

Returns

ComplianceBenchmarkResult

The CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult that was added to the collection.

Add(int, int, string, object, ComplianceBenchmarkResultType)

Adds a new result to the collection.

public ComplianceBenchmarkResult Add(int referenceNumberLevel1, int referenceNumberLevel2, string title, object configuredValue, ComplianceBenchmarkResultType resultType)

Parameters

referenceNumberLevel1 int

The level 1 reference number for the result.

referenceNumberLevel2 int

The level 2 reference number for the result.

title string

The title for the result.

configuredValue object

The configured value at the time of the scan.

resultType ComplianceBenchmarkResultType

The result type.

Returns

ComplianceBenchmarkResult

The CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult that was added to the collection.

Add(int, int, string, object, bool)

Adds a new result to the collection.

public ComplianceBenchmarkResult Add(int referenceNumberLevel1, int referenceNumberLevel2, string title, object configuredValue, bool passCondition)

Parameters

referenceNumberLevel1 int

The level 1 reference number for the result.

referenceNumberLevel2 int

The level 2 reference number for the result.

title string

The title for the result.

configuredValue object

The configured value at the time of the scan.

passCondition bool

A boolean value that indicates whether the success condition was met.

Returns

ComplianceBenchmarkResult

The CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult that was added to the collection.

Exists(SerializableReferenceNumber)

Determines whether a CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult with the specified reference number exists within the collection.

public bool Exists(SerializableReferenceNumber referenceNumber)

Parameters

referenceNumber SerializableReferenceNumber

The reference number of the CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult to locate.

Returns

bool

The System.Boolean value that indicates whether a result with the specified reference number exists in the collection..

ExistsBySectionNumber(int)

Determines whether there are results in the specified level1 section.

public bool ExistsBySectionNumber(int level1)

Parameters

level1 int

The level one section number.

Returns

bool

A System.Boolean value that indicates whether there are results in the specified section number.

FindByReferenceNumber(SerializableReferenceNumber)

Returns the CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult with the specified reference number, or null if no result with that reference number is found.

public ComplianceBenchmarkResult FindByReferenceNumber(SerializableReferenceNumber referenceNumber)

Parameters

referenceNumber SerializableReferenceNumber

The reference number of the CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult to locate.

Returns

ComplianceBenchmarkResult

The CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult with the specified reference number.

FindByReferenceNumber(int, int)

Returns the CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult with the specified reference number, or null if no result with that reference number is found.

public ComplianceBenchmarkResult FindByReferenceNumber(int major, int minor)

Parameters

major int

The major reference number of the CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult to locate.

minor int

The minor reference number of the CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult to locate.

Returns

ComplianceBenchmarkResult

The CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult with the specified reference number.

FindByResultType(ComplianceBenchmarkResultType)

Returns the results that have the specified result type.

public ComplianceBenchmarkResultCollection FindByResultType(ComplianceBenchmarkResultType resultType)

Parameters

resultType ComplianceBenchmarkResultType

The CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResultType for which to find.

Returns

ComplianceBenchmarkResultCollection

A CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResultCollection containing the results from this collection with the specified result type.

FindBySectionNumber(int)

Returns the results that are in the specified level 1 section.

public ComplianceBenchmarkResultCollection FindBySectionNumber(int level1)

Parameters

level1 int

The level one section number.

Returns

ComplianceBenchmarkResultCollection

A CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResultCollection containing the results from this collection with the specified section number.

GetMaximumLevel1SectionNumber()

Gets the highest level1 section number in the results.

public int GetMaximumLevel1SectionNumber()

Returns

int

A System.Int32 value that indicates the highest level1 section number of the results the collection.

GetResultTypeBreakdown()

Gets a breakdown of the count of the different result types in the collect.

public CountBreakdown GetResultTypeBreakdown()

Returns

CountBreakdown

A CENTREL.XIA.Configuration.Types.CountBreakdown with the count of each result type.

InsertItem(int, ComplianceBenchmarkResult)

Occurs when an item is inserted into the collection.

protected override void InsertItem(int index, ComplianceBenchmarkResult item)

Parameters

index int

The index where the item is to be inserted.

item ComplianceBenchmarkResult

The CENTREL.XIA.Configuration.Types.ComplianceBenchmarkResult that is to be inserted.

Remove(SerializableReferenceNumber)

Removes the result with the specified reference number

public void Remove(SerializableReferenceNumber referenceNumber)

Parameters

referenceNumber SerializableReferenceNumber

The reference number of the result to remove.

Remove(ComplianceBenchmarkResultCollection)

Removes all results in the specified collection.

public void Remove(ComplianceBenchmarkResultCollection results)

Parameters

results ComplianceBenchmarkResultCollection

The results to remove from the collection.

RemoveBySectionNumber(int)

Removes the results in the specified level1 section.

public void RemoveBySectionNumber(int level1)

Parameters

level1 int

The level one section number.

RemoveExcludedResults()

Removes results that are marked as excluded, whether because of platform or client configuration.

public void RemoveExcludedResults()

Sort()

Sorts the Windows benchmark results alphabetically.

public void Sort()