Ofcas.Lk.Api.Client - Version 3.0  3.0.0.113
Ofcas.Lk.Api.Client.Core.ProjectInformation Class Reference

ProjectInformation is the representation of an item from a project information (for example the project information items for 'Special Lengths'). More...

Inheritance diagram for Ofcas.Lk.Api.Client.Core.ProjectInformation:
Ofcas.Lk.Api.Client.Core.CoreObjectBase Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithParent< ProjectInformationContainer > Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithInfo< ProjectInformationInfo > Ofcas.Lk.Api.Client.Core.Disposable Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject Ofcas.Lk.Api.Client.Ui.ProjectInformationUi

Public Member Functions

ProjectInformationInfo Refresh ()
 
OperationInfo CanEdit (string key, object value)
 
ProjectInformationInfo Edit (string key, object value)
 
- 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 Id for all children More...
 
- Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.Disposable
void Dispose ()
 

Properties

ProjectInformationContainer Parent [get]
 
ProjectInformationInfo Info [get]
 
- Properties inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
IServiceFactory< IApiService > ServiceFactory [get]
 For internal purposes only. More...
 
Guid Id [get]
 The unique identifier of the object instance. More...
 
- Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
Guid CoreObjectId [get]
 This property is deprecated. Please use ICoreObject.Id instead. More...
 
Guid Id [get]
 The unique identifier of this core object. More...
 

Additional Inherited Members

- Public Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
Guid CoreObjectId => Id
 This property is deprecated. Please use CoreObjectBase.Id instead. More...
 
- Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
 CoreObjectBase (IServiceFactory< IApiService > serviceFactory, Guid coreObjectId, bool ownsObject=true)
 
CallService< T > (Func< IApiService, T > serviceCall, Guid projectGuid=default(Guid), [CallerMemberName] string callerMethod=null)
 Calls a service function and raises an error if it fails. More...
 
CallServiceWithMessage< T > (Func< IApiService, T > serviceCall, Guid projectGuid=default(Guid), [CallerMemberName] string callerMethod=null)
 Calls a service function and raises an error if it fails. More...
 
override void Dispose (bool disposing)
 
- Protected Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectBase
const string NotSupportedCauseNotImplemented = "This method is not implemented, therefore not supported."
 Default message for methods which are not supported because they are not implemented. More...
 
- Events inherited from Ofcas.Lk.Api.Client.Core.Disposable
Action< DisposableDisposed
 

Detailed Description

ProjectInformation is the representation of an item from a project information (for example the project information items for 'Special Lengths').

Member Function Documentation

◆ CanEdit()

OperationInfo Ofcas.Lk.Api.Client.Core.ProjectInformation.CanEdit ( string  key,
object  value 
)
Exceptions
NotSupportedException

◆ Edit()

ProjectInformationInfo Ofcas.Lk.Api.Client.Core.ProjectInformation.Edit ( string  key,
object  value 
)
Exceptions
NotSupportedException

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