com.exlibris.digitool.repository.ifc

Interface CollectionWebServices

All Superinterfaces:

com.exlibris.core.infra.svc.api.GenericWebService

public interface CollectionWebServices
extends com.exlibris.core.infra.svc.api.GenericWebService

Author:

RivkaT

Method Summary

Modifier and Type	Method and Description
long	createCollection(java.lang.String pdsHandle, Collection collection)
void	deleteCollection(java.lang.String pdsHandle, long id)
void	deleteCollectionThumbnail(java.lang.String pdsHandle, java.lang.Long collectionId)
Collection	getCollectionByExternalId(java.lang.String pdsHandle, java.lang.String externalSystem, java.lang.String externalId)
Collection	getCollectionById(java.lang.String pdsHandle, long id)
Collection	getCollectionByName(java.lang.String pdsHandle, java.lang.String path)
java.lang.String	getCollectionTree(java.lang.String pdsHandle, java.lang.Long collectionId)
void	setCollectionThumbnail(java.lang.String pdsHandle, java.lang.Long collectionId, java.lang.String collectionThumbnail)
void	updateCollection(java.lang.String pdsHandle, Collection collection, java.lang.String sort)

Methods inherited from interface com.exlibris.core.infra.svc.api.GenericWebService

getHeartBit

Method Detail

deleteCollection

void deleteCollection(java.lang.String pdsHandle,
                      long id)
               throws UserAuthorizeException,
                      InstitutionAccessException,
                      com.exlibris.core.sdk.exceptions.DeleteCollectionException,
                      InvalidCollectionInfoException

Parameters:

pdsHandle - of a logged in user

id - the collection's id

Throws:

UserAuthorizeException

InstitutionAccessException

com.exlibris.core.sdk.exceptions.DeleteCollectionException

InvalidCollectionInfoException

java.lang.Exception

getCollectionById

Collection getCollectionById(java.lang.String pdsHandle,
                             long id)
                      throws UserAuthorizeException,
                             InstitutionAccessException,
                             com.exlibris.core.sdk.exceptions.NoCollectionFoundException

Parameters:

pdsHandle - of a logged in user

id - the collection's id

Returns:

a Collection object representing the requested collection.

Throws:

UserAuthorizeException

InstitutionAccessException

com.exlibris.core.sdk.exceptions.NoCollectionFoundException

java.lang.Exception

getCollectionByName

Collection getCollectionByName(java.lang.String pdsHandle,
                               java.lang.String path)
                        throws UserAuthorizeException,
                               InstitutionAccessException,
                               com.exlibris.core.sdk.exceptions.NoCollectionFoundException

Parameters:

pdsHandle - of a logged in user

path - the full path of the collection. The path separator must be "/" (e.g coll1/coll2/coll3)

Returns:

a Collection object representing the requested collection.

Throws:

UserAuthorizeException

InstitutionAccessException

com.exlibris.core.sdk.exceptions.NoCollectionFoundException

java.lang.Exception

getCollectionByExternalId

Collection getCollectionByExternalId(java.lang.String pdsHandle,
                                     java.lang.String externalSystem,
                                     java.lang.String externalId)
                              throws UserAuthorizeException,
                                     com.exlibris.core.sdk.exceptions.NoCollectionFoundException

Parameters:

pdsHandle - of a logged in user

externalSystem - the name of the external system

externalId - the id of the external system

Returns:

a Collection object representing the requested collection.

Throws:

UserAuthorizeException

com.exlibris.core.sdk.exceptions.NoCollectionFoundException

java.lang.Exception

updateCollection

void updateCollection(java.lang.String pdsHandle,
                      Collection collection,
                      java.lang.String sort)
               throws UserAuthorizeException,
                      InstitutionAccessException,
                      InvalidCollectionInfoException,
                      InvalidMIDException,
                      InvalidTypeException,
                      InvalidXmlException,
                      java.lang.Exception

Parameters:

pdsHandle - of a logged in user

collection - a Collection object representing the updated collection

sort - the sub collections of the given collection

Throws:

UserAuthorizeException

InstitutionAccessException

InvalidCollectionInfoException

InvalidMIDException

InvalidTypeException

InvalidXmlException

java.lang.Exception

createCollection

long createCollection(java.lang.String pdsHandle,
                      Collection collection)
               throws UserAuthorizeException,
                      InvalidCollectionInfoException,
                      InvalidMIDException,
                      InvalidTypeException,
                      InvalidXmlException,
                      java.lang.Exception

Parameters:

pdsHandle - of a logged in user

collection - a Collection object representing the created collection

Returns:

the id of the created collection

Throws:

UserAuthorizeException

InvalidCollectionInfoException

InvalidMIDException

InvalidTypeException

InvalidXmlException

java.lang.Exception

getCollectionTree

java.lang.String getCollectionTree(java.lang.String pdsHandle,
                                   java.lang.Long collectionId)
                            throws UserAuthorizeException,
                                   InvalidCollectionInfoException,
                                   InvalidMIDException,
                                   InvalidTypeException,
                                   InvalidXmlException

Parameters:

pdsHandle - of a logged in user

collection - a Collection object representing the collection

Returns:

a Collection object representing the requested collection

Throws:

UserAuthorizeException

InvalidCollectionInfoException

InvalidMIDException

InvalidTypeException

InvalidXmlException

java.lang.Exception

setCollectionThumbnail

void setCollectionThumbnail(java.lang.String pdsHandle,
                            java.lang.Long collectionId,
                            java.lang.String collectionThumbnail)
                     throws UserAuthorizeException,
                            com.exlibris.core.sdk.exceptions.NoCollectionFoundException,
                            java.io.IOException,
                            java.lang.Exception

Throws:

UserAuthorizeException

com.exlibris.core.sdk.exceptions.NoCollectionFoundException

java.io.IOException

java.lang.Exception

deleteCollectionThumbnail

void deleteCollectionThumbnail(java.lang.String pdsHandle,
                               java.lang.Long collectionId)
                        throws UserAuthorizeException,
                               com.exlibris.core.sdk.exceptions.NoCollectionFoundException

Throws:

UserAuthorizeException

com.exlibris.core.sdk.exceptions.NoCollectionFoundException