public interface CollectionWebServices
extends com.exlibris.core.infra.svc.api.GenericWebService
| 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) |
void deleteCollection(java.lang.String pdsHandle,
long id)
throws UserAuthorizeException,
InstitutionAccessException,
com.exlibris.core.sdk.exceptions.DeleteCollectionException,
InvalidCollectionInfoException
pdsHandle - of a logged in userid - the collection's idUserAuthorizeExceptionInstitutionAccessExceptioncom.exlibris.core.sdk.exceptions.DeleteCollectionExceptionInvalidCollectionInfoExceptionjava.lang.ExceptionCollection getCollectionById(java.lang.String pdsHandle, long id) throws UserAuthorizeException, InstitutionAccessException, com.exlibris.core.sdk.exceptions.NoCollectionFoundException
pdsHandle - of a logged in userid - the collection's idUserAuthorizeExceptionInstitutionAccessExceptioncom.exlibris.core.sdk.exceptions.NoCollectionFoundExceptionjava.lang.ExceptionCollection getCollectionByName(java.lang.String pdsHandle, java.lang.String path) throws UserAuthorizeException, InstitutionAccessException, com.exlibris.core.sdk.exceptions.NoCollectionFoundException
pdsHandle - of a logged in userpath - the full path of the collection. The path separator must be "/" (e.g coll1/coll2/coll3)UserAuthorizeExceptionInstitutionAccessExceptioncom.exlibris.core.sdk.exceptions.NoCollectionFoundExceptionjava.lang.ExceptionCollection getCollectionByExternalId(java.lang.String pdsHandle, java.lang.String externalSystem, java.lang.String externalId) throws UserAuthorizeException, com.exlibris.core.sdk.exceptions.NoCollectionFoundException
pdsHandle - of a logged in userexternalSystem - the name of the external systemexternalId - the id of the external systemUserAuthorizeExceptioncom.exlibris.core.sdk.exceptions.NoCollectionFoundExceptionjava.lang.Exceptionvoid updateCollection(java.lang.String pdsHandle,
Collection collection,
java.lang.String sort)
throws UserAuthorizeException,
InstitutionAccessException,
InvalidCollectionInfoException,
InvalidMIDException,
InvalidTypeException,
InvalidXmlException,
java.lang.Exception
pdsHandle - of a logged in usercollection - a Collection object representing the updated collectionsort - the sub collections of the given collectionUserAuthorizeExceptionInstitutionAccessExceptionInvalidCollectionInfoExceptionInvalidMIDExceptionInvalidTypeExceptionInvalidXmlExceptionjava.lang.Exceptionlong createCollection(java.lang.String pdsHandle,
Collection collection)
throws UserAuthorizeException,
InvalidCollectionInfoException,
InvalidMIDException,
InvalidTypeException,
InvalidXmlException,
java.lang.Exception
pdsHandle - of a logged in usercollection - a Collection object representing the created collectionid of the created collectionUserAuthorizeExceptionInvalidCollectionInfoExceptionInvalidMIDExceptionInvalidTypeExceptionInvalidXmlExceptionjava.lang.Exceptionjava.lang.String getCollectionTree(java.lang.String pdsHandle,
java.lang.Long collectionId)
throws UserAuthorizeException,
InvalidCollectionInfoException,
InvalidMIDException,
InvalidTypeException,
InvalidXmlException
pdsHandle - of a logged in usercollection - a Collection object representing the collectionUserAuthorizeExceptionInvalidCollectionInfoExceptionInvalidMIDExceptionInvalidTypeExceptionInvalidXmlExceptionjava.lang.Exceptionvoid 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
UserAuthorizeExceptioncom.exlibris.core.sdk.exceptions.NoCollectionFoundExceptionjava.io.IOExceptionjava.lang.Exceptionvoid deleteCollectionThumbnail(java.lang.String pdsHandle,
java.lang.Long collectionId)
throws UserAuthorizeException,
com.exlibris.core.sdk.exceptions.NoCollectionFoundException
UserAuthorizeExceptioncom.exlibris.core.sdk.exceptions.NoCollectionFoundException