Ofcas.Lk.Api.Core.Project Class Reference

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

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

Public Member Functions
	Project (IApiService apiService, Guid coreObjectId, ProjectCenter parent, ProjectInfo coreInfo)
Elevation	GetElevation (ElevationInfo elevationInfo)
	Returns the corresponding elevation based on the given information data. More...
ElevationInfo	CreateLkElevation (string elevationName, ElementType elementType, string shortDescription, double amount, bool isAlternative)
	Creates a new Elevation to the LogiKal projectvia user interface. More...
void	DeleteLkElevation (ElevationInfo elevationInfo)
	Deletes the corresponding logikal elevation based on the given information data. More...
IList< ReportCategory >	GetAvailableUserReports ()
	Return all available reports. More...
string	GetNextPositionNumber (string phase="")
	Retrieves the next available position number of the stated phase. More...
ProjectInfo	SetParameter (string key, object value)
	Takes the parameter to update the project. More...
override ElevationInfo	ExecuteBasicOperation (ElevationInfo sourceInfo, BasicOperationItem basicOperation, IDictionary< string, object > parameters)

Protected Member Functions
ElevationInfo	GetElevationFromLkGuid (Guid lkElevationGuid)
virtual CoreObjectBase	GetElevationObject (Guid responseNewCoreObjectId, ElevationInfo elevationInfo)
override List< BasicOperationItem >	GetBasicOperationItems (ElevationInfo sourceInfo)

Detailed Description

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

Member Function Documentation

CreateLkElevation()

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

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)
shortDescription	(shortDescription)
amount	(amount)
isAlternative

Returns

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

Exceptions

ApiException

contains api error message

DeleteLkElevation()

void Ofcas.Lk.Api.Core.Project.DeleteLkElevation

(

ElevationInfo

elevationInfo

)

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

Parameters

elevationInfo

The elevation information

GetAvailableUserReports()

IList<ReportCategory> Ofcas.Lk.Api.Core.Project.GetAvailableUserReports

(

)

Return all available reports.

Returns

Reports sorted by category (ReportCategory)

GetElevation()

Elevation Ofcas.Lk.Api.Core.Project.GetElevation

(

ElevationInfo

elevationInfo

)

Returns the corresponding elevation based on the given information data.

Parameters

elevationInfo

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

Returns

the Elevation

Exceptions

ApiException

If getting elevation failed.

GetNextPositionNumber()

string Ofcas.Lk.Api.Core.Project.GetNextPositionNumber

(

string

phase = ""

)

Retrieves the next available position number of the stated phase.

Parameters

phase

The phase in which the position number is checked.

Returns

Returns the next available position number for the stated phase.

SetParameter()

ProjectInfo Ofcas.Lk.Api.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:

• Ofcas.Lk.Api.Core/Project.cs