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

Inheritance diagram for Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< TParent, TOwnInfo, TChild, TChildInfo >:

Public Member Functions
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	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 Member Functions inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithInfo< TOwnInfo >
OperationInfo	CanEdit (string key, object value)
	Checks whether Edit can be executed with given parameters. More...

TOwnInfo	Edit (string key, object value)
	Edits this object with given parameters. 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)

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...

Properties
TParent	Parent `[get]`

TOwnInfo	CoreInfo `[get, protected set]`

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...

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithParent< TParent >
TParent	Parent `[get]`
	The parent of this object. More...

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithInfo< TOwnInfo >
TOwnInfo	CoreInfo `[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 >	Infos => new ReadOnlyCollection<TChildInfo>(_infoListContainer.Infos)

Protected Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< TChild, TChildInfo >
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

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

Detailed Description

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

Template Parameters

TParent	The specifc type of parent (base ICoreObject).
TOwnInfo	The specifc type of the own info (base ICoreInfo).
TChild	The specific type of the child (base ICoreObject).
TChildInfo	The 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

apiService	The active instance of IApiService.
coreObjectId	The unique identifier of this object.
parent	The parent of this object.
ownInfo	The 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

Exceptions

NotSupportedException

Reimplemented in Ofcas.Lk.Api.Client.Core.Elevation, and Ofcas.Lk.Api.Client.Core.Project.

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

Core/src/CoreObjectFullyQualified.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CoreObjectFullyQualified()

Member Function Documentation

◆ Edit()