dataverse-client-javascript/src/collections/domain/repositories/ICollectionsRepository.ts at 8115382872bb39e19a2f0578d7a2539e0046e1ab · IQSS/dataverse-client-javascript · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
import { CollectionDTO } from '../dtos/CollectionDTO'
import { FeaturedItemsDTO } from '../dtos/FeaturedItemsDTO'
import { Collection } from '../models/Collection'
import { CollectionFacet } from '../models/CollectionFacet'
import { FeaturedItem } from '../models/FeaturedItem'
import { CollectionItemSubset } from '../models/CollectionItemSubset'
import { MyDataCollectionItemSubset } from '../models/MyDataCollectionItemSubset'
import { CollectionSearchCriteria } from '../models/CollectionSearchCriteria'
import { CollectionUserPermissions } from '../models/CollectionUserPermissions'
import { PublicationStatus } from '../../../core/domain/models/PublicationStatus'
import { CollectionItemType } from '../../../collections/domain/models/CollectionItemType'
import { CollectionLinks } from '../models/CollectionLinks'
import { CollectionSummary } from '../models/CollectionSummary'
import { LinkingObjectType } from '../useCases/GetCollectionsForLinking'

export interface ICollectionsRepository {
  getCollection(collectionIdOrAlias: number | string): Promise<Collection>
  createCollection(
    collectionDTO: CollectionDTO,
    parentCollectionId: number | string
  ): Promise<number>
  publishCollection(collectionIdOrAlias: number | string): Promise<void>
  deleteCollection(collectionIdOrAlias: number | string): Promise<void>
  getCollectionFacets(collectionIdOrAlias: number | string): Promise<CollectionFacet[]>
  getCollectionUserPermissions(
    collectionIdOrAlias: number | string
  ): Promise<CollectionUserPermissions>
  setDefaultContributorRole(
    collectionIdOrAlias: number | string,
    roleAlias: string
  ): Promise<void>
  getCollectionItems(
    collectionId?: string,
    limit?: number,
    offset?: number,
    collectionSearchCriteria?: CollectionSearchCriteria,
    searchServiceName?: string,
    showTypeCounts?: boolean
  ): Promise<CollectionItemSubset>
  getMyDataCollectionItems(
    roleIds: number[],
    collectionItemTypes: CollectionItemType[],
    publicationStatuses: PublicationStatus[],
    limit?: number,
    selectedPage?: number,
    searchText?: string,
    otherUserName?: string
  ): Promise<MyDataCollectionItemSubset>
  updateCollection(
    collectionIdOrAlias: number | string,
    updatedCollection: CollectionDTO
  ): Promise<void>
  getCollectionFeaturedItems(collectionIdOrAlias: number | string): Promise<FeaturedItem[]>
  updateCollectionFeaturedItems(
    collectionIdOrAlias: number | string,
    featuredItemDTOs: FeaturedItemsDTO
  ): Promise<FeaturedItem[]>
  deleteCollectionFeaturedItems(collectionIdOrAlias: number | string): Promise<void>
  deleteCollectionFeaturedItem(featuredItemId: number): Promise<void>
  linkCollection(
    linkedCollectionIdOrAlias: number | string,
    linkingCollectionIdOrAlias: number | string
  ): Promise<void>
  unlinkCollection(
    linkedCollectionIdOrAlias: number | string,
    linkingCollectionIdOrAlias: number | string
  ): Promise<void>
  getCollectionLinks(collectionIdOrAlias: number | string): Promise<CollectionLinks>
  getCollectionsForLinking(
    objectType: LinkingObjectType,
    id: number | string,
    searchTerm: string,
    alreadyLinked: boolean
  ): Promise<CollectionSummary[]>
}