Class: WorkspaceApplicationService

Defined in: application/services/core/WorkspaceService.ts:16

Creates and loads the workspace as a Workspace entity bound to the container's workspace storage service, and provides document listing, search and statistics on it.

Constructors

Constructor

new WorkspaceApplicationService(container): WorkspaceApplicationService;

Defined in: application/services/core/WorkspaceService.ts:20

Parameters

Parameter	Type	Description
container	ServiceContainer	Service container providing the workspace storage service.

Returns

WorkspaceApplicationService

Methods

addDocument()

addDocument(_workspaceId, documentSnapshot): Promise<Document>;

Defined in: application/services/core/WorkspaceService.ts:71

Add a document to a workspace

Parameters

Parameter	Type
_workspaceId	string
documentSnapshot	DocumentInstance

Returns

Promise<Document>

---

getDocuments()

getDocuments(_workspaceId): Promise<Document[]>;

Defined in: application/services/core/WorkspaceService.ts:63

Get all documents in a workspace

Parameters

Parameter	Type
_workspaceId	string

Returns

Promise<Document[]>

---

getStatistics()

getStatistics(_workspaceId): Promise<{
  avgQaScore: number;
  documentCount: number;
  failingDocuments: number;
  folderCount: number;
  name: string;
  passingDocuments: number;
  profileCount: number;
  qaTarget: number;
  workspaceId: string;
}>;

Defined in: application/services/core/WorkspaceService.ts:105

Get workspace statistics

Parameters

Parameter	Type
_workspaceId	string

Returns

Promise<{ avgQaScore: number; documentCount: number; failingDocuments: number; folderCount: number; name: string; passingDocuments: number; profileCount: number; qaTarget: number; workspaceId: string; }>

---

getWorkspace()

getWorkspace(): Promise<Workspace>;

Defined in: application/services/core/WorkspaceService.ts:43

Get the current workspace as active entity

Returns

Promise<Workspace>

---

initialize()

initialize(config): Promise<Workspace>;

Defined in: application/services/core/WorkspaceService.ts:26

Initialize a new workspace US-WS-001: Initialize New Workspace

Parameters

Parameter	Type
config	WorkspaceFactoryConfig

Returns

Promise<Workspace>

---

removeDocument()

removeDocument(_workspaceId, documentId): Promise<void>;

Defined in: application/services/core/WorkspaceService.ts:85

Remove a document from a workspace

Parameters

Parameter	Type
_workspaceId	string
documentId	string

Returns

Promise<void>

---

saveWorkspace()

saveWorkspace(workspace): Promise<Workspace>;

Defined in: application/services/core/WorkspaceService.ts:54

Create or update a workspace

Parameters

Parameter	Type
workspace	Workspace

Returns

Promise<Workspace>

---

searchDocuments()

searchDocuments(_workspaceId, query): Promise<Document[]>;

Defined in: application/services/core/WorkspaceService.ts:93

Search documents in a workspace

Parameters

Parameter	Type
_workspaceId	string
query	string

Returns

Promise<Document[]>