Phase is the representation of a LogiKal phase. The children are of type Elevation. The children can be received from the InfoList (CoreObject<T>.Infos). More...

Inheritance diagram for Ofcas.Lk.Api.Client.Core.Phase:

Public Member Functions
	Phase (IApiService apiService, Guid coreObjectId, Project parent, PhaseInfo coreInfo)
	Creates a new phase. 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 Elevation	GetChild (ElevationInfo elevationInfo)

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< Project, PhaseInfo, Elevation, ElevationInfo >
virtual OperationInfo	CanEdit (string key, object value)

virtual TOwnInfo	Edit (string key, object value)

Protected Member Functions
override CoreInfoResponse	GetInfoResponse ()

virtual Elevation	CreateNewInstance (Guid responseNewCoreObjectId, ElevationInfo elevationInfo)

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.CoreObjectFullyQualified< Project, PhaseInfo, Elevation, ElevationInfo >
TParent	Parent `[get]`

TOwnInfo	CoreInfo `[get, protected set]`

Detailed Description

Phase is the representation of a LogiKal phase. The children are of type Elevation. The children can be received from the InfoList (CoreObject<T>.Infos).

Constructor & Destructor Documentation

◆ Phase()

Ofcas.Lk.Api.Client.Core.Phase.Phase	(	IApiService	apiService,
		Guid	coreObjectId,
		Project	parent,
		PhaseInfo	coreInfo
	)

Creates a new phase.

Parameters

apiService	The used IApiService.
coreObjectId	The core object id for this object.
parent	The parent of this object.
coreInfo	The info used to create this object.

Member Function Documentation

◆ CanCreateChild()

override OperationInfo Ofcas.Lk.Api.Client.Core.Phase.CanCreateChild ( )

Checks whether an elevation can be created or not.

Returns

◆ CanDeleteChild()

override OperationInfo Ofcas.Lk.Api.Client.Core.Phase.CanDeleteChild ( ElevationInfo elevationInfo )

Checks whether an elevation can be deleted or not.

Parameters

elevationInfo The info of the elevation to be deleted.

Returns

◆ CreateChild()

override ElevationInfo Ofcas.Lk.Api.Client.Core.Phase.CreateChild ( )

Creates a new elevation with a default name. Call Elevation.Edit with WellKnownEditKeys.Elevation to change values.

Returns: Returns an info object of the created elevation.

◆ CreateLkElevation()

ElevationInfo Ofcas.Lk.Api.Client.Core.Phase.CreateLkElevation	(	string	elevationName,
		ElementType	elementType,
		string	shortDescription,
		double	amount,
		bool	isAlternative
	)

Creates a new Elevation in this phase via user interface.

Parameters

elevationName	The name of the new elevation
elementType	The type of the new elevation (ElementType)
shortDescription	The short descripton of the new elevation.
amount	The amount for the new elevation.
isAlternative

TODO(nhu) isAlternative?

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

Exceptions

ApiException Thrown if creation of elevation failed.

◆ DeleteChild()

override void Ofcas.Lk.Api.Client.Core.Phase.DeleteChild ( ElevationInfo elevationInfo )

Deletes an elevation based on an info object.

Parameters

elevationInfo The info of the elevation to be deleted.

◆ DeleteLkElevation()

void Ofcas.Lk.Api.Client.Core.Phase.DeleteLkElevation ( ElevationInfo elevationInfo )

Deletes the corresponding logikal elevation based on the given information data.

Parameters

elevationInfo The elevation information

◆ GetElevation()

Elevation Ofcas.Lk.Api.Client.Core.Phase.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 Elevation created based on the given information.

Exceptions

ApiException Throw if getting elevation failed.

◆ GetNextPositionNumber()

string Ofcas.Lk.Api.Client.Core.Phase.GetNextPositionNumber ( )

Retrieves the next available position number of this phase.

Returns: Returns the next available position number for this phase.

◆ IsChild()

bool Ofcas.Lk.Api.Client.Core.Phase.IsChild ( ElevationInfo elevationInfo )

protected

Determines if the provided info is the info a child of this object.

Parameters

elevationInfo

Returns: Returns true if the info is the info a child of this obejct

◆ SetParameter()

PhaseInfo Ofcas.Lk.Api.Client.Core.Phase.SetParameter	(	string	key,
		object	value
	)

Takes the parameter to update the phase.

Parameters

key	The parameter key. Available keys are:

PHASE_NAME: string. Changes the phase's name.

PHASE_DESCRIPTION: string. Changes the phase's description.

Parameters

value The value for the parameter.

Returns: Returns the updated PhaseInfo.

Exceptions

ApiException Occurs if any exception occured.

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

Core/src/Phase.cs

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Phase()

Member Function Documentation

◆ CanCreateChild()

◆ CanDeleteChild()

◆ CreateChild()

◆ CreateLkElevation()

◆ DeleteChild()

◆ DeleteLkElevation()

◆ GetElevation()

◆ GetNextPositionNumber()

◆ IsChild()

◆ SetParameter()