Package de.digitalcollections.cudami.client.identifiable.entity

Class CudamiCollectionsClient

java.lang.Object

de.digitalcollections.cudami.client.CudamiBaseClient<de.digitalcollections.model.identifiable.entity.Collection>

de.digitalcollections.cudami.client.identifiable.entity.CudamiCollectionsClient

public class CudamiCollectionsClient
extends CudamiBaseClient<de.digitalcollections.model.identifiable.entity.Collection>

Field Summary

Fields inherited from class de.digitalcollections.cudami.client.CudamiBaseClient

http, mapper, reader, serverUri, targetType

Constructor Summary

Constructors

Constructor	Description
CudamiCollectionsClient(HttpClient http, String serverUrl, com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Summary

Modifier and Type	Method	Description
boolean	addDigitalObject(UUID collectionUuid, UUID digitalObjectUuid)
boolean	addDigitalObjects(UUID collectionUuid, List<de.digitalcollections.model.identifiable.entity.DigitalObject> digitalObjects)
boolean	addSubcollection(UUID collectionUuid, UUID subcollectionUuid)
boolean	addSubcollections(UUID collectionUuid, List<de.digitalcollections.model.identifiable.entity.Collection> subcollections)
long	count()
de.digitalcollections.model.identifiable.entity.Collection	create()
de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection>	find(de.digitalcollections.model.paging.PageRequest pageRequest)
de.digitalcollections.model.paging.SearchPageResponse<de.digitalcollections.model.identifiable.entity.Collection>	find(de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)
List<de.digitalcollections.model.identifiable.entity.Collection>	find(String searchTerm, int maxResults)
de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection>	findActive(de.digitalcollections.model.paging.PageRequest pageRequest)
de.digitalcollections.model.paging.SearchPageResponse<de.digitalcollections.model.identifiable.entity.Collection>	findActive(de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)
de.digitalcollections.model.identifiable.entity.Collection	findActiveOne(UUID uuid, Locale locale)
de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection>	findActiveSubcollections(UUID uuid, de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)
de.digitalcollections.model.identifiable.entity.Collection	findOne(UUID uuid)
de.digitalcollections.model.identifiable.entity.Collection	findOne(UUID uuid, String locale)
de.digitalcollections.model.identifiable.entity.Collection	findOne(UUID uuid, Locale locale)
de.digitalcollections.model.identifiable.entity.Collection	findOneByIdentifier(String namespace, String id)
de.digitalcollections.model.identifiable.entity.Collection	findOneByRefId(long refId)
de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection>	findSubcollections(UUID uuid, de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)
de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection>	findTopCollections(de.digitalcollections.model.paging.PageRequest pageRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
de.digitalcollections.model.paging.SearchPageResponse<de.digitalcollections.model.identifiable.entity.Collection>	findTopCollections(de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)
de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection>	getActiveSubcollections(UUID uuid, de.digitalcollections.model.paging.PageRequest pageRequest)
de.digitalcollections.model.view.BreadcrumbNavigation	getBreadcrumbNavigation(UUID uuid)
de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.DigitalObject>	getDigitalObjects(UUID collectionUuid, de.digitalcollections.model.paging.PageRequest pageRequest)	Deprecated, for removal: This API element is subject to removal in a future version.
de.digitalcollections.model.paging.SearchPageResponse<de.digitalcollections.model.identifiable.entity.DigitalObject>	getDigitalObjects(UUID collectionUuid, de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)
de.digitalcollections.model.identifiable.entity.Collection	getParent(UUID uuid)
List<de.digitalcollections.model.identifiable.entity.Collection>	getParents(UUID uuid)
List<de.digitalcollections.model.identifiable.entity.agent.CorporateBody>	getRelatedCorporateBodies(UUID uuid, de.digitalcollections.model.filter.Filtering filtering)
de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection>	getSubcollections(UUID uuid, de.digitalcollections.model.paging.PageRequest pageRequest)
List<Locale>	getTopCollectionsLanguages()
boolean	removeDigitalObject(UUID collectionUuid, UUID digitalObjectUuid)
boolean	removeSubcollection(UUID collectionUuid, UUID subcollectionUuid)
de.digitalcollections.model.identifiable.entity.Collection	save(de.digitalcollections.model.identifiable.entity.Collection collection)
boolean	saveDigitalObjects(UUID collectionUuid, List<de.digitalcollections.model.identifiable.entity.DigitalObject> digitalObjects)
de.digitalcollections.model.identifiable.entity.Collection	saveWithParentCollection(de.digitalcollections.model.identifiable.entity.Collection collection, UUID parentCollectionUuid)
de.digitalcollections.model.identifiable.entity.Collection	update(UUID uuid, de.digitalcollections.model.identifiable.entity.Collection collection)

Methods inherited from class de.digitalcollections.cudami.client.CudamiBaseClient

createFullUri, doDeleteRequestForString, doGetRequestForObject, doGetRequestForObject, doGetRequestForObjectList, doGetRequestForObjectList, doGetRequestForObjectList, doGetRequestForPagedObjectList, doGetRequestForPagedObjectList, doGetRequestForString, doGetSearchRequestForPagedObjectList, doGetSearchRequestForPagedObjectList, doPatchRequestForString, doPatchRequestForString, doPostRequestForObject, doPostRequestForObject, doPostRequestForObject, doPostRequestForObject, doPostRequestForObjectList, doPostRequestForObjectList, doPostRequestForString, doPostRequestForString, doPutRequestForObject, doPutRequestForObject, doPutRequestForObjectList, doPutRequestForString, findByLanguageAndInitial, findByLanguageAndInitial

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CudamiCollectionsClient

public CudamiCollectionsClient(HttpClient http,
                               String serverUrl,
                               com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Detail

addDigitalObject

public boolean addDigitalObject(UUID collectionUuid,
                                UUID digitalObjectUuid)
                         throws HttpException

Throws:

HttpException

addDigitalObjects

public boolean addDigitalObjects(UUID collectionUuid,
                                 List<de.digitalcollections.model.identifiable.entity.DigitalObject> digitalObjects)
                          throws HttpException

Throws:

HttpException

addSubcollection

public boolean addSubcollection(UUID collectionUuid,
                                UUID subcollectionUuid)
                         throws HttpException

Throws:

HttpException

addSubcollections

public boolean addSubcollections(UUID collectionUuid,
                                 List<de.digitalcollections.model.identifiable.entity.Collection> subcollections)
                          throws HttpException

Throws:

HttpException

count

public long count()
           throws HttpException

Throws:

HttpException

create

public de.digitalcollections.model.identifiable.entity.Collection create()

find

public de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection> find(de.digitalcollections.model.paging.PageRequest pageRequest)
                                                                                                                 throws HttpException

Throws:

HttpException

find

public de.digitalcollections.model.paging.SearchPageResponse<de.digitalcollections.model.identifiable.entity.Collection> find(de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)
                                                                                                                       throws HttpException

Throws:

HttpException

find

public List<de.digitalcollections.model.identifiable.entity.Collection> find(String searchTerm,
                                                                             int maxResults)
                                                                      throws HttpException

Throws:

HttpException

findActive

public de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection> findActive(de.digitalcollections.model.paging.PageRequest pageRequest)
                                                                                                                       throws HttpException

Throws:

HttpException

findActive

public de.digitalcollections.model.paging.SearchPageResponse<de.digitalcollections.model.identifiable.entity.Collection> findActive(de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)
                                                                                                                             throws HttpException

Throws:

HttpException

findActiveOne

public de.digitalcollections.model.identifiable.entity.Collection findActiveOne(UUID uuid,
                                                                                Locale locale)
                                                                         throws HttpException

Throws:

HttpException

findActiveSubcollections

public de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection> findActiveSubcollections(UUID uuid,
                                                                                                                                            de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)
                                                                                                                                     throws HttpException

Throws:

HttpException

findOne

public de.digitalcollections.model.identifiable.entity.Collection findOne(UUID uuid)
                                                                   throws HttpException

Throws:

HttpException

findOne

public de.digitalcollections.model.identifiable.entity.Collection findOne(UUID uuid,
                                                                          Locale locale)
                                                                   throws HttpException

Throws:

HttpException

findOne

public de.digitalcollections.model.identifiable.entity.Collection findOne(UUID uuid,
                                                                          String locale)
                                                                   throws HttpException

Throws:

HttpException

findOneByIdentifier

public de.digitalcollections.model.identifiable.entity.Collection findOneByIdentifier(String namespace,
                                                                                      String id)
                                                                               throws HttpException

Throws:

HttpException

findOneByRefId

public de.digitalcollections.model.identifiable.entity.Collection findOneByRefId(long refId)
                                                                          throws HttpException

Throws:

HttpException

findSubcollections

public de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection> findSubcollections(UUID uuid,
                                                                                                                                      de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)
                                                                                                                               throws HttpException

Throws:

HttpException

findTopCollections

@Deprecated(since="5.0",
            forRemoval=true)
public de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection> findTopCollections(de.digitalcollections.model.paging.PageRequest pageRequest)
                                                                                                                               throws HttpException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

HttpException

findTopCollections

public de.digitalcollections.model.paging.SearchPageResponse<de.digitalcollections.model.identifiable.entity.Collection> findTopCollections(de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)
                                                                                                                                     throws HttpException

Throws:

HttpException

getActiveSubcollections

public de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection> getActiveSubcollections(UUID uuid,
                                                                                                                                           de.digitalcollections.model.paging.PageRequest pageRequest)
                                                                                                                                    throws HttpException

Throws:

HttpException

getBreadcrumbNavigation

public de.digitalcollections.model.view.BreadcrumbNavigation getBreadcrumbNavigation(UUID uuid)
                                                                              throws HttpException

Throws:

HttpException

getDigitalObjects

@Deprecated(since="5.0",
            forRemoval=true)
public de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.DigitalObject> getDigitalObjects(UUID collectionUuid,
                                                                                                                                        de.digitalcollections.model.paging.PageRequest pageRequest)
                                                                                                                                 throws HttpException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

HttpException

getDigitalObjects

public de.digitalcollections.model.paging.SearchPageResponse<de.digitalcollections.model.identifiable.entity.DigitalObject> getDigitalObjects(UUID collectionUuid,
                                                                                                                                              de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)
                                                                                                                                       throws HttpException

Throws:

HttpException

getParent

public de.digitalcollections.model.identifiable.entity.Collection getParent(UUID uuid)
                                                                     throws HttpException

Throws:

HttpException

getParents

public List<de.digitalcollections.model.identifiable.entity.Collection> getParents(UUID uuid)
                                                                            throws HttpException

Throws:

HttpException

getSubcollections

public de.digitalcollections.model.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection> getSubcollections(UUID uuid,
                                                                                                                                     de.digitalcollections.model.paging.PageRequest pageRequest)
                                                                                                                              throws HttpException

Throws:

HttpException

getRelatedCorporateBodies

public List<de.digitalcollections.model.identifiable.entity.agent.CorporateBody> getRelatedCorporateBodies(UUID uuid,
                                                                                                           de.digitalcollections.model.filter.Filtering filtering)
                                                                                                    throws HttpException

Throws:

HttpException

getTopCollectionsLanguages

public List<Locale> getTopCollectionsLanguages()
                                        throws HttpException

Throws:

HttpException

removeDigitalObject

public boolean removeDigitalObject(UUID collectionUuid,
                                   UUID digitalObjectUuid)
                            throws HttpException

Throws:

HttpException

removeSubcollection

public boolean removeSubcollection(UUID collectionUuid,
                                   UUID subcollectionUuid)
                            throws HttpException

Throws:

HttpException

save

public de.digitalcollections.model.identifiable.entity.Collection save(de.digitalcollections.model.identifiable.entity.Collection collection)
                                                                throws HttpException

Throws:

HttpException

saveDigitalObjects

public boolean saveDigitalObjects(UUID collectionUuid,
                                  List<de.digitalcollections.model.identifiable.entity.DigitalObject> digitalObjects)
                           throws HttpException

Throws:

HttpException

saveWithParentCollection

public de.digitalcollections.model.identifiable.entity.Collection saveWithParentCollection(de.digitalcollections.model.identifiable.entity.Collection collection,
                                                                                           UUID parentCollectionUuid)
                                                                                    throws HttpException

Throws:

HttpException

update

public de.digitalcollections.model.identifiable.entity.Collection update(UUID uuid,
                                                                         de.digitalcollections.model.identifiable.entity.Collection collection)
                                                                  throws HttpException

Throws:

HttpException