Realisation of ICoreObjectWithChildren<TChild,TChildInfo>. More...

Inheritance diagram for Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >:

Public Member Functions
void	DisposeChild (ICoreObject coreObject)

bool	IsParentOf (ICoreObject coreObject)

abstract TChildInfo	RefreshChild (TChildInfo childInfo)

void	RefreshChildren ()

virtual TChild	GetChild (TChildInfo childInfo)

virtual IEnumerable< TChild >	GetChildren (IEnumerable< TChildInfo > childrenInfos=null)

virtual OperationInfo	CanCreateChild ()

virtual TChildInfo	CreateChild ()

virtual OperationInfo	CanDeleteChild (TChildInfo childInfo)

virtual void	DeleteChild (TChildInfo childInfo)

virtual OperationInfo	CanMoveFrom (ICoreInfo coreInfo, bool deepCheck=true)

virtual TChildInfo	MoveFrom (ICoreInfo coreInfo)

virtual OperationInfo	CanCopyFrom (ICoreInfo coreInfo, bool deepCheck=true)

virtual TChildInfo	CopyFrom (ICoreInfo coreInfo)

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
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 Id for all children More...

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.Disposable
void	Dispose ()

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< TChild, TChildInfo >
void	DisposeChild (ICoreObject childObject)
	Disposes a child object in the own hierarchy. Will not dispose itself. More...

bool	IsParentOf (ICoreObject coreObject)
	Checks this ICoreObjectWithChildren is a parent of the given ICoreObject. More...

ICoreInfo	RefreshChild (ICoreInfo childInfo)
	Refreshes the given child info and returns an updated version. More...

void	RefreshChildren ()
	Refreshes the children of this core object. More...

Public Attributes
IList< TChildInfo >	ChildrenInfos => _infoListContainer.Infos

Public Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
Guid	CoreObjectId => Id
	This property is deprecated. Please use CoreObjectBase.Id instead. More...

Protected Member Functions
	CoreObjectWithChildren (IApiService apiService, Guid coreObjectId, bool ownsObject=true)

virtual void	RefreshChildren (bool clearEvents)

TChildInfo	RefreshChild (Predicate< TChildInfo > predicate, object childInformation)
	Refreshes all infos and returns the appropriate info. More...

abstract IEnumerable< TChildInfo >	GetChildrenInfos ()
	Gets the children infos. More...

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
	CoreObjectBase (IApiService apiService, Guid coreObjectId, bool ownsObject=true)

T	CallService< T > (Func< IApiService, T > serviceCall, [CallerMemberName] string callerMethod=null)
	Calls a service function and raises an error if it fails. More...

T	CallServiceWithMessage< T > (Func< IApiService, T > serviceCall, [CallerMemberName] string callerMethod=null)
	Calls a service function and raises an error if it fails. More...

override void	Dispose (bool disposing)

Additional Inherited Members
Protected Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
const string	NotSupportedCauseNotImplemented
	Default message for methods which are not supported because they are not implemented. More...

Properties inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
IApiService	ApiService `[get]`
	The service interface. More...

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

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
Guid	CoreObjectId `[get]`
	This property is deprecated. Please use ICoreObject.Id instead. More...

Guid	Id `[get]`
	The unique identifier of this core object. More...

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

Detailed Description

Realisation of ICoreObjectWithChildren<TChild,TChildInfo>.

Template Parameters

TChild	The specific type of the child (base ICoreObject).
TChildInfo	The specific type of the child infos (base ICoreInfo).

Type Constraints

TChildInfo	:	ICoreInfo
TChild	:	ICoreObject

Member Function Documentation

◆ CopyFrom()

virtual TChildInfo Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >.CopyFrom ( ICoreInfo coreInfo )

virtual

Exceptions

NotSupportedException

◆ CreateChild()

virtual TChildInfo Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >.CreateChild ( )

virtual

Exceptions

NotSupportedException

◆ DeleteChild()

virtual void Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >.DeleteChild ( TChildInfo childInfo )

virtual

Exceptions

NotSupportedException

◆ GetChild()

virtual TChild Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >.GetChild ( TChildInfo childInfo )

virtual

Exceptions

NotSupportedException

◆ GetChildren()

virtual IEnumerable<TChild> Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >.GetChildren ( IEnumerable< TChildInfo > childrenInfos = null )

virtual

Exceptions

NotSupportedException

◆ GetChildrenInfos()

abstract IEnumerable<TChildInfo> Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >.GetChildrenInfos ( )

protectedpure virtual

Gets the children infos.

Returns: Returns the children infos.

Implemented in Ofcas.Lk.Api.Client.Core.LoginScope, and Ofcas.Lk.Api.Client.Core.DocumentContainer.

◆ MoveFrom()

virtual TChildInfo Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >.MoveFrom ( ICoreInfo coreInfo )

virtual

Exceptions

NotSupportedException

◆ RefreshChild()

TChildInfo Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >.RefreshChild	(	Predicate< TChildInfo >	predicate,
		object	childInformation
	)

protected

Refreshes all infos and returns the appropriate info.

Parameters

predicate	The predicate for the given info.
childInformation	Additional information identifying the child in case of error.

Returns: Returns the refreshed info object.

Exceptions

ApiException if the child was not include in the list

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

Core/src/CoreObjectWithChildren.cs

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CopyFrom()

◆ CreateChild()

◆ DeleteChild()

◆ GetChild()

◆ GetChildren()

◆ GetChildrenInfos()

◆ MoveFrom()

◆ RefreshChild()