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

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

Public Member Functions
override OperationInfo	CanEdit (string key, object value)
	Checks whether a project can be edited or not. More...

override ProjectInfo	Edit (string key, object value)
	Edits a project based on a key and a value. More...

Phase	GetPhase (PhaseInfo phaseInfo)
	Returns the corresponding phase based on the given information data. More...

PhaseInfo	CreatePhase (string name, string description)
	Creates a new Phase to the LogiKal projectvia user interface. More...

void	DeletePhase (PhaseInfo phaseInfo)
	Deletes a phase from this project. More...

IList< ReportCategory >	GetAvailableUserReports ()
	Return all available reports. More...

override PhaseInfo	RefreshChild (PhaseInfo childInfo)

override Phase	GetChild (PhaseInfo childInfo)

ProjectInfo	SetParameter (string key, object value)
	Takes the parameter to update the project. More...

OperationInfo	CanAdd (ICoreInfo coreInfo)
	Used to check if an ElevationInfo can be added to a project of type ProjectType.FabricationLot. More...

PhaseInfo	Add (ICoreInfo coreInfo)
	Used to add an ElevationInfo to a project of type ProjectType.FabricationLot. More...

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< ProjectCenter, ProjectInfo, Phase, PhaseInfo >
TOwnInfo	Refresh ()

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

Public Attributes
DocumentContainer	Documents => _documentContainerManager.GetDocumentContainer()

Protected Member Functions
override CoreInfoResponse	GetInfoResponse ()

virtual Phase	CreateNewInstance (Guid coreObjectId, PhaseInfo phaseInfo)

override void	Dispose (bool disposing)

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

Properties
ISynchronizationContainer	SynchronizationContainer `[get]`

Properties inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< ProjectCenter, ProjectInfo, Phase, PhaseInfo >
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

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

Member Function Documentation

◆ Add()

PhaseInfo Ofcas.Lk.Api.Client.Core.Project.Add ( ICoreInfo coreInfo )

Used to add an ElevationInfo to a project of type ProjectType.FabricationLot.

Parameters

coreInfo The ElevationInfo to add.

Returns: Returns a PhaseInfo of the FabricationLot the ElevationInfo belongs to.

◆ CanAdd()

OperationInfo Ofcas.Lk.Api.Client.Core.Project.CanAdd ( ICoreInfo coreInfo )

Used to check if an ElevationInfo can be added to a project of type ProjectType.FabricationLot.

Parameters

coreInfo The ElevationInfo to add.

Returns: Returns a OperationInfo.

◆ CanEdit()

override OperationInfo Ofcas.Lk.Api.Client.Core.Project.CanEdit	(	string	key,
		object	value
	)

virtual

Checks whether a project can be edited or not.

Parameters

key	The key of the value to be edited. See WellKnownEditKeys.Project for all available edit keys.
value	The value to be set.

Returns

Reimplemented from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< ProjectCenter, ProjectInfo, Phase, PhaseInfo >.

◆ CreatePhase()

PhaseInfo Ofcas.Lk.Api.Client.Core.Project.CreatePhase	(	string	name,
		string	description
	)

Creates a new Phase to the LogiKal projectvia user interface.

Parameters

name	The name of the new elevation
description	The description of the new phase

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

Exceptions

ApiException contains api error message

◆ DeletePhase()

void Ofcas.Lk.Api.Client.Core.Project.DeletePhase ( PhaseInfo phaseInfo )

Deletes a phase from this project.

Parameters

phaseInfo The info of phase to be deleted.

◆ Edit()

override ProjectInfo Ofcas.Lk.Api.Client.Core.Project.Edit	(	string	key,
		object	value
	)

virtual

Edits a project based on a key and a value.

Parameters

key	The key of the value to be edited. See WellKnownEditKeys.Project for all available edit keys.
value	The value to be set.

Returns: Returns an info object of the edited project.

Reimplemented from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< ProjectCenter, ProjectInfo, Phase, PhaseInfo >.

◆ GetAvailableUserReports()

IList<ReportCategory> Ofcas.Lk.Api.Client.Core.Project.GetAvailableUserReports ( )

Return all available reports.

Returns: Reports sorted by category (ReportCategory)

◆ GetPhase()

Phase Ofcas.Lk.Api.Client.Core.Project.GetPhase ( PhaseInfo phaseInfo )

Returns the corresponding phase based on the given information data.

Parameters

info	The phase information obtained through the CoreObject<T>.Infos function.

Returns: the Elevation

Exceptions

ApiException If getting phase failed.

◆ SetParameter()

ProjectInfo Ofcas.Lk.Api.Client.Core.Project.SetParameter	(	string	key,
		object	value
	)

Takes the parameter to update the project.

Parameters

key	The parameter key. Available keys are:

PROJECT_NAME: sets a new project name, value-type: string

Parameters

value The parameter value.

Returns: the updated ProjectInfo

Exceptions

ApiException contains api error message

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

Core/src/Project.cs

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Add()

◆ CanAdd()

◆ CanEdit()

◆ CreatePhase()

◆ DeletePhase()

◆ Edit()

◆ GetAvailableUserReports()

◆ GetPhase()

◆ SetParameter()