public interface IEWebServices
extends com.exlibris.core.infra.svc.api.GenericWebService
Modifier and Type | Method and Description |
---|---|
void |
assignSharedMD(java.lang.String pdsHandle,
java.lang.String pid,
java.lang.String mid)
Assign an Access Rights policy or exception.
|
java.lang.String |
createSharedMD(java.lang.String pdsHandle,
MetaData metadata)
Creates a new Access Rights policy or exception.
|
void |
deleteSharedMD(java.lang.String pdsHandle,
java.lang.String mid)
Delete an (unassigned) Access Rights policy or exception
|
void |
generateFixityEvent(java.lang.String PDShandle,
FixityEvent event)
This method sends a fixity event for Rosetta to process.
|
java.lang.String |
getIE(java.lang.String pdsHandle,
java.lang.String iePid,
java.lang.Long flags)
Returns the METS of the IE.
|
java.lang.String |
getIEMD(java.lang.String pdsHandle,
java.lang.String iePID)
Deprecated.
|
java.lang.String |
getMD(java.lang.String pdsHandle,
java.lang.String pid,
java.lang.String mid,
java.lang.String type,
java.lang.String subType)
API for getting the MD of an IE , REP or File, Only MD on entity level (which is in Permanent) is returned.
The ID of the source MD section is the mid (saved in Rosetta DB) No parameters - return all PID's MDs MID - return matching MD (ignore type, subtype if provided) type (only) - return all matching for type type+subType - return all matching for type+subtype subType (only) - not supported type+subType mismatch - error Supported type:subType pairs: descriptive: dc source: marc, dc, mods, text_md, image_niso,video_md, audio_md, copyrights, rights, other, ead, OTHER:article mets_section: structMap |
java.lang.String |
getRipStatus(java.lang.String pdsHandle,
java.lang.Long ripID)
Returns the current status of the given rip, can be one of the following: Finished, In Process - {stage}, In TA - {stage}.
|
java.util.List<MetaData> |
getSharedMD(java.lang.String pdsHandle,
java.lang.String pid,
java.lang.String type,
java.lang.String subType)
Retrieve an Access Rights policy or exception.
|
MetaData |
getSharedMDByMid(java.lang.String pdsHandle,
java.lang.String mid)
Retrieve an Access Rights policy or exception by its mid.
|
java.util.List<MetaData> |
getSharedMDByType(java.lang.String pdsHandle,
java.lang.String type,
java.lang.String subType)
Retrieves all Access Rights policies or exceptions.
|
void |
unassignSharedMD(java.lang.String pdsHandle,
java.lang.String pid,
java.lang.String mid)
Unassign an Access Rights policy or exception.
|
void |
updateIEMD(java.lang.String pdsHandle,
java.lang.String iePID,
MetaData[] metadata)
Deprecated.
|
void |
updateMD(java.lang.String pdsHandle,
java.lang.String pid,
MetaData[] metadata)
API for updating the MD on a IE, REP or File.
|
long |
updateRepresentation(java.lang.String pdsHandle,
java.lang.String iePid,
java.lang.String repPid,
java.lang.String submissionReason,
RepresentationContent[] representationContent)
This method update an existing representation, according to the given RevisionContent objects list.
|
void |
updateSharedMD(java.lang.String pdsHandle,
MetaData metadata)
Update an existing Access Rights policy or exception.
|
@Deprecated java.lang.String getIEMD(java.lang.String pdsHandle, java.lang.String iePID) throws NotInPermanentException, UserAuthorizeException, IEWSException
java.lang.String getMD(java.lang.String pdsHandle, java.lang.String pid, java.lang.String mid, java.lang.String type, java.lang.String subType) throws NotInPermanentException, UserAuthorizeException, IEWSException
pdsHandle
- PID
- mid
- type
- subType
- NotInPermanentException
UserAuthorizeException
IEWSException
@Deprecated void updateIEMD(java.lang.String pdsHandle, java.lang.String iePID, MetaData[] metadata) throws UserAuthorizeException, NotInPermanentException, InvalidMIDException, InvalidTypeException, InvalidXmlException, LockedIeException, IEWSException
void updateMD(java.lang.String pdsHandle, java.lang.String pid, MetaData[] metadata) throws UserAuthorizeException, NotInPermanentException, InvalidMIDException, InvalidTypeException, InvalidXmlException, LockedIeException, IEWSException
pdsHandle
- pid
- metadata
- type, subType parameters (and valid values) - mandatory
mid - optional, if provided mid will be updatedUserAuthorizeException
NotInPermanentException
InvalidMIDException
InvalidTypeException
InvalidXmlException
LockedIeException
IEWSException
java.lang.Exception
void generateFixityEvent(java.lang.String PDShandle, FixityEvent event) throws UserAuthorizeException, com.exlibris.core.sdk.exceptions.FixityEventException, LockedIeException
PDShandle
- event
- a FixityEvent
objectUserAuthorizeException
com.exlibris.core.sdk.exceptions.FixityEventException
java.lang.Exception
LockedIeException
java.lang.String getRipStatus(java.lang.String pdsHandle, java.lang.Long ripID) throws UserAuthorizeException, IEWSException
pdsHandle
- ripID
- UserAuthorizeException
IEWSException
java.lang.String getIE(java.lang.String pdsHandle, java.lang.String iePid, java.lang.Long flags) throws UserAuthorizeException, IEWSException
flags
- 0 - for none (export the latest IE version, including only the latest reps and files) pdsHandle
- the pds handleiePid
- the ie pidUserAuthorizeException
IEWSException
long updateRepresentation(java.lang.String pdsHandle, java.lang.String iePid, java.lang.String repPid, java.lang.String submissionReason, RepresentationContent[] representationContent) throws UserAuthorizeException, LockedIeException, com.exlibris.core.sdk.exceptions.FixityEventException, NotInPermanentException, IEWSException, InvalidMIDException, InvalidTypeException, InvalidXmlException
pdsHandle
- iePid
- The IE under which this representation would be updatedrepPid
- The representation which is updatedsubmissionReason
- The submission reason for the updaterepresentationContent
- A RepresentationContent
object. Represents the updated content (i.e. the difference between the existing Rep, file-wise)UserAuthorizeException
LockedIeException
IEWSException
NotInPermanentException
com.exlibris.core.sdk.exceptions.FixityEventException
InvalidXmlException
InvalidTypeException
InvalidMIDException
java.lang.Exception
java.lang.String createSharedMD(java.lang.String pdsHandle, MetaData metadata) throws UserAuthorizeException, InvalidTypeException, InvalidXmlException, IEWSException
pdsHandle
- metadata
- - metadata.content = Access Rights XML, metdata.mid - (null) , metadata.subType = accessrights, metadata.type = policy|local.UserAuthorizeException
InvalidTypeException
InvalidXmlException
IEWSException
void updateSharedMD(java.lang.String pdsHandle, MetaData metadata) throws UserAuthorizeException, InvalidTypeException, InvalidMIDException, IEWSException, InvalidXmlException
pdsHandle
- metadata
- - metadata.content = Access Rights XML, metdata.mid = Existing Access Rights MD id , metadata.subType - (null), metadata.type = (null).UserAuthorizeException
InvalidTypeException
InvalidMIDException
java.lang.Exception
IEWSException
InvalidXmlException
void deleteSharedMD(java.lang.String pdsHandle, java.lang.String mid) throws UserAuthorizeException, InvalidMIDException
pdsHandle
- mid
- = Existing Access Rights MD idUserAuthorizeException
InvalidMIDException
java.util.List<MetaData> getSharedMD(java.lang.String pdsHandle, java.lang.String pid, java.lang.String type, java.lang.String subType) throws UserAuthorizeException, IEWSException
pdsHandle
- pid
- = IE or REP pid from permanenttype
- = policy|local|(null)subType
- = accessrightsUserAuthorizeException
InvalidMIDException
IEWSException
java.util.List<MetaData> getSharedMDByType(java.lang.String pdsHandle, java.lang.String type, java.lang.String subType) throws UserAuthorizeException, IEWSException
pdsHandle
- type
- = policy|local|(null)subType
- = accessrightsUserAuthorizeException
InvalidMIDException
IEWSException
MetaData getSharedMDByMid(java.lang.String pdsHandle, java.lang.String mid) throws UserAuthorizeException, InvalidMIDException
pdsHandle
- mid
- - Existing Access Rights mid.UserAuthorizeException
InvalidMIDException
void assignSharedMD(java.lang.String pdsHandle, java.lang.String pid, java.lang.String mid) throws UserAuthorizeException, InvalidMIDException, NotInPermanentException, LockedIeException, IEWSException
pdsHandle
- pid
- - IE or REP unlocked pid from permanentmid
- - Existing Access Rights mid.UserAuthorizeException
InvalidMIDException
NotInPermanentException
LockedIeException
IEWSException
void unassignSharedMD(java.lang.String pdsHandle, java.lang.String pid, java.lang.String mid) throws UserAuthorizeException, InvalidMIDException, NotInPermanentException, LockedIeException, IEWSException
pdsHandle
- pid
- - IE or REP pid from permanentmid
- - Existing Access Rights mid. Policy can only be unassigned from a REP pid.UserAuthorizeException
InvalidMIDException
NotInPermanentException
LockedIeException
IEWSException