Ofcas.Lk.Api.V3  3.0.0.98
Ofcas.Lk.Api.Core.CoreObjectBase Class Reference

CoreObjectBase is the base class for all objects and holds general data (for example, the object instance ID of the parent). Each object is assigned with a unique identification number (CoreObjectId) More...

Inheritance diagram for Ofcas.Lk.Api.Core.CoreObjectBase:
Ofcas.Lk.Api.Core.Disposable Ofcas.Lk.Api.Core.Document Ofcas.Lk.Api.Core.ElevationInstance Ofcas.Lk.Api.Core.ProgramRuntime

Public Member Functions

bool CanDispose ()
 Returns the information about whether the object can be deleted. An object can only be deleted if no children live. More...
 
IList< Guid > Children ()
 Returns a list with CoreObjectId for all children More...
 
- Public Member Functions inherited from Ofcas.Lk.Api.Core.Disposable
void Dispose ()
 

Protected Member Functions

override void Dispose (bool disposing)
 
 CoreObjectBase (IApiService apiService, Guid coreObjectId)
 
 CoreObjectBase (IApiService apiService, Guid coreObjectId, CoreObjectBase parent)
 
 CoreObjectBase (IApiService apiService, Guid coreObjectId, CoreObjectBase parent, ICoreInfo coreInfo)
 

Protected Attributes

IApiService _apiService = null
 

Properties

Guid CoreObjectId [get]
 The unique identifier of the object instance More...
 
Guid ParentCoreObjectId [get]
 The unique identifier from the parent object instance More...
 
ICoreInfo CoreInfo [get, protected set]
 Holds the included informations to the current object More...
 
DocumentContainer Documents [get]
 Returns the DocumentContainer to handle documents to the object. More...
 
- Properties inherited from Ofcas.Lk.Api.Core.Disposable
bool IsDisposed [get]
 

Additional Inherited Members

- Events inherited from Ofcas.Lk.Api.Core.Disposable
Action< DisposableDisposed
 

Detailed Description

CoreObjectBase is the base class for all objects and holds general data (for example, the object instance ID of the parent). Each object is assigned with a unique identification number (CoreObjectId)

Member Function Documentation

◆ CanDispose()

bool Ofcas.Lk.Api.Core.CoreObjectBase.CanDispose ( )

Returns the information about whether the object can be deleted. An object can only be deleted if no children live.

Returns
true, if the core object can be deleted otherwise false

◆ Children()

IList<Guid> Ofcas.Lk.Api.Core.CoreObjectBase.Children ( )

Returns a list with CoreObjectId for all children

Returns

Property Documentation

◆ CoreInfo

ICoreInfo Ofcas.Lk.Api.Core.CoreObjectBase.CoreInfo
getprotected set

Holds the included informations to the current object

◆ CoreObjectId

Guid Ofcas.Lk.Api.Core.CoreObjectBase.CoreObjectId
get

The unique identifier of the object instance

◆ Documents

DocumentContainer Ofcas.Lk.Api.Core.CoreObjectBase.Documents
get

Returns the DocumentContainer to handle documents to the object.

◆ ParentCoreObjectId

Guid Ofcas.Lk.Api.Core.CoreObjectBase.ParentCoreObjectId
get

The unique identifier from the parent object instance


The documentation for this class was generated from the following file: