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

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

Public Member Functions
void	RefreshInfos ()

virtual TChild	GetChild (TChildInfo childInfo)

virtual OperationInfo	CanCreateChild ()

virtual TChildInfo	CreateChild ()

virtual OperationInfo	CanDeleteChild (TChildInfo coreInfo)

virtual void	DeleteChild (TChildInfo coreInfo)

virtual OperationInfo	CanMoveFrom (TChildInfo coreInfo)

virtual TChildInfo	MoveFrom (TChildInfo coreInfo)

virtual OperationInfo	CanCopyFrom (TChildInfo coreInfo)

virtual TChildInfo	CopyFrom (TChildInfo coreInfo)

virtual OperationInfo	CanAdd (ICoreInfo coreInfo)

virtual TChildInfo	Add (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 CoreObjectId 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	RefreshInfos ()
	Refresh the list of infos. More...

TChild	GetChild (TChildInfo childInfo)
	Gets a child based on the child info. More...

OperationInfo	CanCreateChild ()
	Checks whether CreateChild can be executed. More...

TChildInfo	CreateChild ()
	Creates a child. More...

OperationInfo	CanDeleteChild (TChildInfo coreInfo)
	Checks whether DeleteChild can be executed with a given child info. More...

void	DeleteChild (TChildInfo coreInfo)
	Deletes a child based on the child info. More...

OperationInfo	CanMoveFrom (TChildInfo coreInfo)
	Checks whether MoveFrom can be executed with a given info. More...

TChildInfo	MoveFrom (TChildInfo coreInfo)
	Moves an object based on the info. More...

OperationInfo	CanCopyFrom (TChildInfo coreInfo)
	Checks whether CopyFrom can be executed with a given info. More...

TChildInfo	CopyFrom (TChildInfo coreInfo)
	Copies an object based on the info. More...

OperationInfo	CanAdd (ICoreInfo coreInfo)
	Checks whether Add can be executed with a given ICoreInfo. More...

TChildInfo	Add (ICoreInfo coreInfo)
	Adds an object based on a ICoreInfo. More...

Public Attributes
IList< TChildInfo >	Infos => new ReadOnlyCollection<TChildInfo>(_infoListContainer.Infos)

Protected Member Functions
	CoreObjectWithChildren (IApiService apiService, Guid coreObjectId)

abstract CoreInfoResponse	GetInfoResponse ()
	Gets the info response from service. More...

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
	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
const string	NotSupportedCauseNotImplemented
	Default message for methods which are not supported because they are not implemented. More...

Protected Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
readonly IApiService	_apiService

Additional Inherited Members
Properties inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
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...

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< TChild, TChildInfo >
IList< TChildInfo >	Infos `[get]`
	The list of infos representing the children. 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

◆ Add()

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

virtual

Exceptions

NotSupportedException

◆ CopyFrom()

virtual TChildInfo Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >.CopyFrom ( TChildInfo 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 coreInfo )

virtual

Exceptions

NotSupportedException

◆ GetChild()

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

virtual

Exceptions

NotSupportedException

◆ GetInfoResponse()

abstract CoreInfoResponse Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >.GetInfoResponse ( )

protectedpure virtual

Gets the info response from service.

Returns: Return the CoreInfoResponse.

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 ( TChildInfo coreInfo )

virtual

Exceptions

NotSupportedException

Member Data Documentation

◆ NotSupportedCauseNotImplemented

const string Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >.NotSupportedCauseNotImplemented

protected

Initial value:

=

"This method is not implemented, therefore not supported."

Default message for methods which are not supported because they are not implemented.

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

Core/src/CoreObjectWithChildren.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Add()

◆ CopyFrom()

◆ CreateChild()

◆ DeleteChild()

◆ GetChild()

◆ GetInfoResponse()

◆ MoveFrom()

Member Data Documentation

◆ NotSupportedCauseNotImplemented