Bexel Manager API Documentation
Bexel.Api.IReadOnlyElementSystemCollection Interface Reference

Represents a read-only collection of Bexel.Api.ElementSystems. More...

Inheritance diagram for Bexel.Api.IReadOnlyElementSystemCollection:
IReadOnlyCollection

Public Member Functions

ElementSystem GetSystemByID (ElementSystemID id)
 Retrieves the element system with the specified ID. More...
 
ElementSystem GetSystemByID (int internalID)
 Retrieves the element system with the specified internal ID. More...
 
ElementSystem GetSystemByName (string name)
 Retrieves the element system with the specified name. More...
 
IEnumerable< ElementSystemGetSystemsByName (string name)
 Retrieves the element systems with the specified name. More...
 

Detailed Description

Represents a read-only collection of Bexel.Api.ElementSystems.

Member Function Documentation

◆ GetSystemByID() [1/2]

ElementSystem Bexel.Api.IReadOnlyElementSystemCollection.GetSystemByID ( ElementSystemID  id)

Retrieves the element system with the specified ID.

Parameters
idID of the element system.
Returns
An element system with the specified ID, null if no such element system exists within the collection.

◆ GetSystemByID() [2/2]

ElementSystem Bexel.Api.IReadOnlyElementSystemCollection.GetSystemByID ( int  internalID)

Retrieves the element system with the specified internal ID.

Parameters
internalIDInternal ID of the element system.
Returns
An element system with the specified internal ID, null if no such element system exists within the collection.

◆ GetSystemByName()

ElementSystem Bexel.Api.IReadOnlyElementSystemCollection.GetSystemByName ( string  name)

Retrieves the element system with the specified name.

Parameters
nameName of the element system.
Returns
An element system with the specified name, null if no such element system exists within the collection.

◆ GetSystemsByName()

IEnumerable<ElementSystem> Bexel.Api.IReadOnlyElementSystemCollection.GetSystemsByName ( string  name)

Retrieves the element systems with the specified name.

Parameters
nameName of the element system.
Returns
All element systems with the specified name, empty collection if no such element systems exist within the collection.