Ofcas.Lk.Api.Client - Version 3.0  3.0.0.106
Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo > Class Template Referenceabstract

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

Inheritance diagram for Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >:
Ofcas.Lk.Api.Client.Core.CoreObjectBase Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< TChild, TChildInfo > Ofcas.Lk.Api.Client.Core.Disposable Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< TParent, TOwnInfo, 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 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)
 
void RefreshInfos ()
 
- 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 Attributes

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

Protected Member Functions

 CoreObjectWithChildren (IApiService apiService, Guid coreObjectId)
 
TChildInfo RefreshChild (Predicate< TChildInfo > predicate)
 Refreshes all infos and returns the appropriate info. More...
 
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)
 
CallService< T > (Func< IApiService, T > serviceCall, [CallerMemberName] string callerMethod=null)
 Calls a service function and raises an error if it fails. More...
 
CallServiceWithMessage< T > (Func< IApiService, T > serviceCall, [CallerMemberName] string callerMethod=null)
 Calls a service function and raises an error if it fails. More...
 

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 CoreObjectId [get]
 The unique identifier of the object instance. More...
 
- Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
Guid CoreObjectId [get]
 The unique identifier of this core object. More...
 
- Events inherited from Ofcas.Lk.Api.Client.Core.Disposable
Action< DisposableDisposed
 

Detailed Description

Realisation of ICoreObjectWithChildren<TChild,TChildInfo>.

Template Parameters
TChildThe specific type of the child (base ICoreObject).
TChildInfoThe 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

◆ 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 ( ICoreInfo  coreInfo)
virtual
Exceptions
NotSupportedException

◆ RefreshChild()

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

Refreshes all infos and returns the appropriate info.

Parameters
predicateThe predicate for the given info.
Returns
Returns the refreshed info object.

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