arlas-web-core / Exports / Contributor

Class: Contributor

Table of contents

Constructors

• constructor

Properties

• cacheDuration
• collaborativeSearcheService
• collection
• collections
• configService
• endCollaborationEvent
• identifier
• isDataUpdating
• linkedContributorId

Accessors

• updateData

Methods

• computeData
• fetchData
• getConfigValue
• getFilterDisplayName
• getName
• getPackageName
• isMyLinkedContributorCollaboration
• isMyOwnCollaboration
• isUpdateEnabledOnOwnCollaboration
• setData
• setName
• setSelection
• updateFromCollaboration

Constructors

constructor

• new Contributor(identifier, configService, collaborativeSearcheService, collection?)

Parameters

Name	Type	Description
identifier	string	identifier of the contributor.
configService	ConfigService	Service to fetch the configuration of the contributor
collaborativeSearcheService	CollaborativesearchService	Service managing the collaborations between contributors
collection?	string	Name of the collection of the contributor

Defined in

models/contributor.ts:49

Properties

cacheDuration

• Protected cacheDuration: number

Defined in

models/contributor.ts:41

---

collaborativeSearcheService

• collaborativeSearcheService: CollaborativesearchService

Service managing the collaborations between contributors

Defined in

models/contributor.ts:51

---

collection

• collection: string

Defined in

models/contributor.ts:35

---

collections

• collections: CollectionAggField[]

Defined in

models/contributor.ts:36

---

configService

• configService: ConfigService

Service to fetch the configuration of the contributor

Defined in

models/contributor.ts:50

---

endCollaborationEvent

• endCollaborationEvent: Subject<CollaborationEvent>

Defined in

models/contributor.ts:37

---

identifier

• identifier: string

identifier of the contributor.

Defined in

models/contributor.ts:49

---

isDataUpdating

• isDataUpdating: boolean = false

Defined in

models/contributor.ts:34

---

linkedContributorId

• linkedContributorId: string

Defined in

models/contributor.ts:39

Accessors

updateData

• get updateData(): boolean

Returns

boolean

whether the data of contributor should be updated.

Defined in

models/contributor.ts:148

• set updateData(value): void

Parameters

Name	Type	Description
value	boolean	set if the data of contributor should be updated or not.

Returns

void

Defined in

models/contributor.ts:155

Methods

computeData

▸ Abstract computeData(data): any

Parameters

Name	Type
data	any

Returns

any

Defined in

models/contributor.ts:167

---

fetchData

▸ Abstract fetchData(collaborationEvent): Observable<any>

Parameters

Name	Type
collaborationEvent	CollaborationEvent

Returns

Observable<any>

Defined in

models/contributor.ts:165

---

getConfigValue

▸ getConfigValue(key): any

Parameters

Name	Type	Description
key	string	a key defined in configuration.

Returns

any

value of the key in configuration.

Defined in

models/contributor.ts:108

---

getFilterDisplayName

▸ Abstract getFilterDisplayName(): string

Returns

string

name and live informations about filter contributor.

Defined in

models/contributor.ts:163

---

getName

▸ getName(): string

Returns

string

name of contributor set in configuration.

Defined in

models/contributor.ts:134

---

getPackageName

▸ Abstract getPackageName(): string

Returns

string

package name of contributor used in configuration.

Defined in

models/contributor.ts:102

---

isMyLinkedContributorCollaboration

▸ isMyLinkedContributorCollaboration(collaborationEvent): boolean

Parameters

Name	Type
collaborationEvent	CollaborationEvent

Returns

boolean

Defined in

models/contributor.ts:125

---

isMyOwnCollaboration

▸ isMyOwnCollaboration(collaborationEvent): boolean

Parameters

Name	Type
collaborationEvent	CollaborationEvent

Returns

boolean

Defined in

models/contributor.ts:121

---

isUpdateEnabledOnOwnCollaboration

▸ Abstract isUpdateEnabledOnOwnCollaboration(): boolean

Returns

boolean

Defined in

models/contributor.ts:119

---

setData

▸ Abstract setData(data): any

Parameters

Name	Type
data	any

Returns

any

Defined in

models/contributor.ts:169

---

setName

▸ setName(name): void

Parameters

Name	Type
name	string

Returns

void

set the name of the contributor

Defined in

models/contributor.ts:141

---

setSelection

▸ Abstract setSelection(data, c): any

Parameters

Name	Type
data	any
c	Collaboration

Returns

any

Defined in

models/contributor.ts:171

---

updateFromCollaboration

▸ updateFromCollaboration(collaborationEvent): void

Parameters

Name	Type
collaborationEvent	CollaborationEvent

Returns

void

Defined in

models/contributor.ts:173