PhaseUi is the representation of a LogiKal phase and provides methods with user interactions. The children are of type ElevationUi. The children can be received from the InfoList (CoreObject<T>.Infos). More...

Inheritance diagram for Ofcas.Lk.Api.Client.Ui.PhaseUi:

Public Member Functions
override OperationInfo	CanMoveFrom (ICoreInfo coreInfo, bool deepCheck=true)

override ElevationInfo	MoveFrom (ICoreInfo coreInfo)
	Moves an object into this phase based on an info object. More...

override OperationInfo	CanCopyFrom (ICoreInfo coreInfo, bool deepCheck=true)

override ElevationInfo	CopyFrom (ICoreInfo coreInfo)
	Copies an object into this phase based on an info object. More...

new ElevationUi	GetElevation (ElevationInfo elevationInfo)
	Returns the corresponding elevation based on the given info object. More...

ElevationInfo	RestoreElevation (ElevationInfo elevationInfo)
	Restore and return the corresponding elevationInfo based on the given information data. A UI window pops when the elevationInfo number of the deleted elevationInfo already exists or when a phase is required More...

ElevationInfo	CreateLkElevation (string elevationName, ElementType elementType)
	Creates a new Elevation to the LogiKal projectvia user interface. More...

ElevationInfo	CopyElevationFrom (ElevationInfo sourceElevationInfo, string elevationName)
	Copies the specified elevation into the calling phase. More...

ElevationInfo	MoveElevationFrom (ElevationInfo sourceElevationInfo, string elevationName)
	Moves the specified elevation into the calling phase. More...

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.Phase
	Phase (IApiService apiService, Guid coreObjectId, Project parent, PhaseInfo coreInfo)
	Creates a new phase. More...

override OperationInfo	CanEdit (string key, object value)
	Checks whether an phase can be edited or not. More...

override PhaseInfo	Edit (string key, object value)
	Edits an phase based on a key and a value. More...

override OperationInfo	CanCreateChild ()
	Checks whether an elevation can be created or not. More...

override ElevationInfo	CreateChild ()
	Creates a new elevation with a default name. Call Elevation.Edit with WellKnownEditKeys.Elevation to change values. More...

override OperationInfo	CanDeleteChild (ElevationInfo elevationInfo)
	Checks whether an elevation can be deleted or not. More...

override void	DeleteChild (ElevationInfo elevationInfo)
	Deletes an elevation based on an info object. More...

Elevation	GetElevation (ElevationInfo elevationInfo)
	Returns the corresponding elevation based on the given info object. More...

ElevationInfo	CreateLkElevation (string elevationName, ElementType elementType, string shortDescription, double amount, bool isAlternative)
	Creates a new Elevation in this phase via user interface. More...

void	DeleteLkElevation (ElevationInfo elevationInfo)
	Deletes the corresponding logikal elevation based on the given information data. More...

string	GetNextPositionNumber ()
	Retrieves the next available position number of this phase. More...

PhaseInfo	SetParameter (string key, object value)
	Takes the parameter to update the phase. More...

override ElevationInfo	RefreshChild (ElevationInfo childInfo)

override Elevation	GetChild (ElevationInfo elevationInfo)

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< Project, PhaseInfo, Elevation, ElevationInfo >
TOwnInfo	Refresh ()

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
bool	CanDispose ()
	Checks whether the ICoreInfo can be disposed. More...

Protected Member Functions
override Elevation	CreateNewInstance (Guid responseNewCoreObjectId, ElevationInfo elevationInfo)

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.Phase
override CoreInfoResponse	GetInfoResponse ()

bool	IsChild (ElevationInfo elevationInfo)
	Determines if the provided info is the info a child of this object. More...

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< Project, PhaseInfo, Elevation, ElevationInfo >
	CoreObjectFullyQualified (IApiService apiService, Guid coreObjectId, TParent parent, TOwnInfo ownInfo)
	Creates a new instance of CoreObjectFullyQualified<TParent,TOwnInfo,TChild,TChildInfo> with the given parameters. More...

Additional Inherited Members
Properties inherited from Ofcas.Lk.Api.Client.Core.Phase
ISynchronizationContainer	SynchronizationContainer `[get]`

Properties inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< Project, PhaseInfo, Elevation, ElevationInfo >
TParent	Parent `[get]`

TOwnInfo	CoreInfo `[get, protected set]`

TOwnInfo	Info `[get, protected set]`

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithSynchronizations
ISynchronizationContainer	SynchronizationContainer `[get]`
	The ISynchronizationContainer of this ICoreObject. More...

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
Guid	CoreObjectId `[get]`
	The unique identifier of this core object. More...

Detailed Description

PhaseUi is the representation of a LogiKal phase and provides methods with user interactions. The children are of type ElevationUi. The children can be received from the InfoList (CoreObject<T>.Infos).

Member Function Documentation

◆ CopyElevationFrom()

ElevationInfo Ofcas.Lk.Api.Client.Ui.PhaseUi.CopyElevationFrom	(	ElevationInfo	sourceElevationInfo,
		string	elevationName
	)

Copies the specified elevation into the calling phase.

Parameters

sourceElevationInfo	The ElevationInfo of the elevation be copied.
elevationName	The name of the copied elevation.

Returns: The ElevationInfo of the copied elevation.

◆ CopyFrom()

override ElevationInfo Ofcas.Lk.Api.Client.Ui.PhaseUi.CopyFrom ( ICoreInfo coreInfo )

Copies an object into this phase based on an info object.

Parameters

coreInfo The info of the object to be copied.

Returns: Returns an info object of the copied / created elevation.

◆ CreateLkElevation()

ElevationInfo Ofcas.Lk.Api.Client.Ui.PhaseUi.CreateLkElevation	(	string	elevationName,
		ElementType	elementType
	)

Creates a new Elevation to the LogiKal projectvia user interface.

Parameters

elevationName	The name of the new elevation
elementType	The type of the new elevation (ElementType)

Returns: The ElevationInfo to the created elevation or NULL if the user rejected the dialog.

Exceptions

Exception contains api error message

◆ GetElevation()

new ElevationUi Ofcas.Lk.Api.Client.Ui.PhaseUi.GetElevation ( ElevationInfo elevationInfo )

Returns the corresponding elevation based on the given info object.

Parameters

elevationInfo The elevation information obtained through the CoreObject<T>.Infos function.

Returns: Returns an ElevationUi created based on the given information.

Exceptions

ApiException Throw if getting elevation failed.

◆ MoveElevationFrom()

ElevationInfo Ofcas.Lk.Api.Client.Ui.PhaseUi.MoveElevationFrom	(	ElevationInfo	sourceElevationInfo,
		string	elevationName
	)

Moves the specified elevation into the calling phase.

Parameters

sourceElevationInfo	The ElevationInfo of the elevation be copied.
elevationName	The name of the copied elevation.

Returns: The ElevationInfo of the copied elevation.

◆ MoveFrom()

override ElevationInfo Ofcas.Lk.Api.Client.Ui.PhaseUi.MoveFrom ( ICoreInfo coreInfo )

Moves an object into this phase based on an info object.

Parameters

coreInfo The info of the object to be moved.

Returns: Returns an info object of the moved / created elevation.

◆ RestoreElevation()

ElevationInfo Ofcas.Lk.Api.Client.Ui.PhaseUi.RestoreElevation ( ElevationInfo elevationInfo )

Restore and return the corresponding elevationInfo based on the given information data. A UI window pops when the elevationInfo number of the deleted elevationInfo already exists or when a phase is required

Parameters

elevationInfo The elevation information obtained through the CoreObject<T>.Infos function.

Returns: ElevationInfo

Exceptions

Exception If restore elevation failed or the passed elevationInfo is not deleted

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

Ui/src/PhaseUi.cs

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CopyElevationFrom()

◆ CopyFrom()

◆ CreateLkElevation()

◆ GetElevation()

◆ MoveElevationFrom()

◆ MoveFrom()

◆ RestoreElevation()