DocumentContainer gives access to manage documents. Documents can be used in projects (Project). More...

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

Public Member Functions
Document	GetDocument (DocumentInfo documentInfo)
	Returns the corresponding document based on the given information data. More...

DocumentInfo	CreateDocument (string name, string suffix, DocumentType type, Stream content)
	Creates a document with the specific name, suffix, type and content. More...

void	DeleteDocument (DocumentInfo documentInfo)
	Deletes a document specified by an info object. More...

override DocumentInfo	ExecuteBasicOperation (DocumentInfo sourceInfo, BasicOperationItem basicOperation, IDictionary< string, object > parameters)

Protected Member Functions
override List< BasicOperationItem >	GetBasicOperationItems (DocumentInfo sourceInfo)

Detailed Description

DocumentContainer gives access to manage documents. Documents can be used in projects (Project).

Member Function Documentation

DocumentInfo Ofcas.Lk.Api.Core.DocumentContainer.CreateDocument	(	string	name,
		string	suffix,
		DocumentType	type,
		Stream	content
	)

Creates a document with the specific name, suffix, type and content.

Parameters

name	Specifies the name of the document.
suffix	Specifies the suffix of the document.
type	Specifies the type of the document.
content	Specifies the content of the document.

void Ofcas.Lk.Api.Core.DocumentContainer.DeleteDocument ( DocumentInfo documentInfo )

Deletes a document specified by an info object.

Parameters

documentInfo Specifies the document to be deleted.

Document Ofcas.Lk.Api.Core.DocumentContainer.GetDocument ( DocumentInfo documentInfo )

Returns the corresponding document based on the given information data.

Parameters

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

Exceptions

Exception If getting document failed.

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