Ofcas.Lk.Api.Client - Version 3.0  3.0.0.111
Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< TParent, TOwnInfo, TChild, TChildInfo > Class Template Reference

Realisation of ICoreObjectWithChildren<TChild,TChildInfo>, ICoreObjectWithParent<TParent>, ICoreObjectWithInfo<TOwnInfo>. More...

Inheritance diagram for Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< TParent, TOwnInfo, TChild, TChildInfo >:
Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo > Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithParent< TParent > Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithInfo< TOwnInfo > 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

Public Member Functions

virtual TOwnInfo Refresh ()
 
virtual OperationInfo CanEdit (string key, object value)
 
virtual TOwnInfo Edit (string key, object value)
 
- Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >
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...
 

Protected Member Functions

 CoreObjectFullyQualified (IApiService apiService, Guid coreObjectId, TParent parent, TOwnInfo ownInfo)
 Creates a new instance of CoreObjectFullyQualified<TParent,TOwnInfo,TChild,TChildInfo> with the given parameters. More...
 
- Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >
 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)
 
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...
 
override void Dispose (bool disposing)
 

Properties

TParent Parent [get]
 
TOwnInfo Info [get]
 
- 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...
 
- Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithParent< TParent >
ICoreObject Parent [get]
 The parent of this object. More...
 
- Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithInfo< TOwnInfo >
ICoreInfo Info [get]
 The own info of this object. More...
 

Additional Inherited Members

- Public Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >
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 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...
 
- Events inherited from Ofcas.Lk.Api.Client.Core.Disposable
Action< DisposableDisposed
 

Detailed Description

Realisation of ICoreObjectWithChildren<TChild,TChildInfo>, ICoreObjectWithParent<TParent>, ICoreObjectWithInfo<TOwnInfo>.

Template Parameters
TParentThe specifc type of parent (base ICoreObject).
TOwnInfoThe specifc type of the own info (base ICoreInfo).
TChildThe specific type of the child (base ICoreObject).
TChildInfoThe specific type of the child infos (base ICoreInfo).
Type Constraints
TParent :ICoreObject 
TOwnInfo :ICoreInfo 
TChild :ICoreObject 
TChildInfo :ICoreInfo 

Constructor & Destructor Documentation

◆ CoreObjectFullyQualified()

Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< TParent, TOwnInfo, TChild, TChildInfo >.CoreObjectFullyQualified ( IApiService  apiService,
Guid  coreObjectId,
TParent  parent,
TOwnInfo  ownInfo 
)
protected

Creates a new instance of CoreObjectFullyQualified<TParent,TOwnInfo,TChild,TChildInfo> with the given parameters.

Parameters
apiServiceThe active instance of IApiService.
coreObjectIdThe unique identifier of this object.
parentThe parent of this object.
ownInfoThe own info of this object.

Member Function Documentation

◆ Edit()

virtual TOwnInfo Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< TParent, TOwnInfo, TChild, TChildInfo >.Edit ( string  key,
object  value 
)
virtual

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