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.Client.Core.CoreObjectBase:

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.Client.Core.Disposable
void	Dispose ()

Protected Member Functions
	CoreObjectBase (IApiService apiService, Guid coreObjectId)

override void	Dispose (bool disposing)

virtual void	OnSynchronizedEventReceived (ISynchronizedEvent synchronizedEvent)
	Gets called when a synchronized event was received. More...

void	RaiseIfFailed (BaseResponse response, [CallerMemberName] string callerMethod=null)
	Raises an ApiException if the stated BaseResponse indicates a failure. More...

Protected Attributes
readonly IApiService	_apiService

Properties
Guid	CoreObjectId `[get]`
	The unique identifier of the object instance. More...

DocumentContainer	Documents `[get]`
	Returns the DocumentContainer to handle documents to the object. More...

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
Guid	CoreObjectId `[get]`
	The unique identifier of this core object. More...

Additional Inherited Members
Events inherited from Ofcas.Lk.Api.Client.Core.Disposable
Action< Disposable >	Disposed

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.Client.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

Implements Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject.

◆ Children()

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

Returns a list with CoreObjectId for all children

Returns

◆ OnSynchronizedEventReceived()

virtual void Ofcas.Lk.Api.Client.Core.CoreObjectBase.OnSynchronizedEventReceived ( ISynchronizedEvent synchronizedEvent )

protectedvirtual

Gets called when a synchronized event was received.

Parameters

synchronizedEvent The received synchronized event.

◆ RaiseIfFailed()

void Ofcas.Lk.Api.Client.Core.CoreObjectBase.RaiseIfFailed	(	BaseResponse	response,
		[CallerMemberName] string	callerMethod = `null`
	)

protected

Raises an ApiException if the stated BaseResponse indicates a failure.

Parameters

response	The response to be checked.
callerMethod	The caller method.

Exceptions

ApiException Occurs if the BaseResponse indicates a failure.

Property Documentation

◆ CoreObjectId

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

get

The unique identifier of the object instance.

◆ Documents

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

get

Returns the DocumentContainer to handle documents to the object.

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

Core/src/CoreObjectBase.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members