Ofcas.Lk.Api.Client - Version 3.0  3.0.0.103
Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo > Interface Template Reference

Represents a ICoreObject with children. More...

Inheritance diagram for Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >:
Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject

Public Member Functions

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 Member Functions inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
bool CanDispose ()
 Checks whether the ICoreInfo can be disposed. More...
 

Properties

IList< TChildInfo > Infos [get]
 The list of infos representing the children. More...
 
- Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
Guid CoreObjectId [get]
 The unique identifier of this core object. More...
 

Detailed Description

Represents a ICoreObject with children.

Template Parameters
TChildThe specific type of the child (base ICoreObject).
TChildInfoThe specific type of the child infos (base ICoreInfo).
Type Constraints
TChild :ICoreObject 
TChildInfo :ICoreInfo 

Member Function Documentation

◆ Add()

TChildInfo Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >.Add ( ICoreInfo  coreInfo)

Adds an object based on a ICoreInfo.

Parameters
coreInfoThe ICoreInfo of the object to be added.
Returns
Returns the chilf info of the added object.

◆ CanAdd()

OperationInfo Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >.CanAdd ( ICoreInfo  coreInfo)

Checks whether Add can be executed with a given ICoreInfo.

Parameters
coreInfoThe ICoreInfo of the object to be added.
Returns
Returns an OperationInfo which indicates if Add can be executed.

◆ CanCopyFrom()

OperationInfo Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >.CanCopyFrom ( TChildInfo  coreInfo)

Checks whether CopyFrom can be executed with a given info.

Parameters
coreInfoThe info of the object to be copied.
Returns
Returns an OperationInfo which indicates if CopyFrom can be executed.

◆ CanCreateChild()

OperationInfo Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >.CanCreateChild ( )

Checks whether CreateChild can be executed.

Returns
Returns an OperationInfo which indicates if CreateChild can be executed.

◆ CanDeleteChild()

OperationInfo Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >.CanDeleteChild ( TChildInfo  coreInfo)

Checks whether DeleteChild can be executed with a given child info.

Parameters
coreInfoThe info of the child to be deleted.
Returns
Returns an OperationInfo which indicates if DeleteChild can be executed.

◆ CanMoveFrom()

OperationInfo Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >.CanMoveFrom ( TChildInfo  coreInfo)

Checks whether MoveFrom can be executed with a given info.

Parameters
coreInfoThe info of the object to be moved.
Returns
Returns an OperationInfo which indicates if MoveFrom can be executed.

◆ CopyFrom()

TChildInfo Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >.CopyFrom ( TChildInfo  coreInfo)

Copies an object based on the info.

Parameters
coreInfoThe info of the object to be copied.
Returns
Returns the child info of the copied object.

◆ CreateChild()

TChildInfo Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >.CreateChild ( )

Creates a child.

Returns
Returns the child info of the created child.

◆ DeleteChild()

void Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >.DeleteChild ( TChildInfo  coreInfo)

Deletes a child based on the child info.

Parameters
coreInfoThe info of the child to be deleted.

◆ GetChild()

TChild Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >.GetChild ( TChildInfo  childInfo)

Gets a child based on the child info.

Parameters
childInfoThe info object of the child to be get.
Returns
Returns the child based on the given child info.

◆ MoveFrom()

TChildInfo Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >.MoveFrom ( TChildInfo  coreInfo)

Moves an object based on the info.

Parameters
coreInfoThe info of the object to be moved.
Returns
Returns the child info of the moved object.

◆ RefreshInfos()

void Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >.RefreshInfos ( )

Refresh the list of infos.

Property Documentation

◆ Infos

IList<TChildInfo> Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithChildren< out out TChild, TChildInfo >.Infos
get

The list of infos representing the children.


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