Interface IDocumentService

Interface for a service that loads, saves and deletes documents and manages document related data

Inherited Members
Namespace: Simplic.Document
Assembly: Simplic.Document.dll
Syntax
public interface IDocumentService : IDocumentRepository

Methods

| Improve this Doc View Source

CheckOutDocument(Document, DocumentVersion)

Checks out the document for editing.

Declaration
void CheckOutDocument(Document document, DocumentVersion selectedVersion)
Parameters
Type Name Description
Document.Document document
DocumentVersion selectedVersion

Version for editing.
| Improve this Doc View Source

DiscardChanges(Document)

Leaves edit mode and discards current changes to the document.

Declaration
void DiscardChanges(Document document)
Parameters
Type Name Description
Document.Document document
| Improve this Doc View Source

GenerateBarcode(Document)

Generates a barcode for the given document.

Declaration
string GenerateBarcode(Document document)
Parameters
Type Name Description
Document.Document document
Returns
Type Description
System.String
| Improve this Doc View Source

GetById(Guid)

Gets a document by its id

Declaration
[Obsolete("Method is deprecated, please use Get() instead.")]
Document GetById(Guid id)
Parameters
Type Name Description
System.Guid id

The id of a document
Returns
Type Description
Document.Document
| Improve this Doc View Source

GetCheckoutBasePath()

Gets the checkout base path.

Declaration
string GetCheckoutBasePath()
Returns
Type Description
System.String
| Improve this Doc View Source

GetCheckoutFileName(Document, DocumentVersion)

Gets the checkout file name.

Declaration
string GetCheckoutFileName(Document document, DocumentVersion documentVersion)
Parameters
Type Name Description
Document.Document document
DocumentVersion documentVersion
Returns
Type Description
System.String
| Improve this Doc View Source

GetReleasedBlob(Guid)

Gets the released blob of a given document from the database.

Declaration
byte[] GetReleasedBlob(Guid documentId)
Parameters
Type Name Description
System.Guid documentId
Returns
Type Description
System.Byte[]