com.exlibris.dps.sdk.sip

Interface SipWebServices

All Superinterfaces:

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

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

Web Service for getting information on created SIPs.

Author:

zvif

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getSipIEs(java.lang.String sipId) API for getting the IEs related to a certain SIP
java.lang.String	getSipStatus(java.lang.String sipId) Deprecated.
com.exlibris.repository.persistence.sip.SIPStatusInfo	getSIPStatusInfo(java.lang.String SipId) API for getting the SIP Info

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

getHeartBit

Method Detail

getSipStatus

@Deprecated
java.lang.String getSipStatus(java.lang.String sipId)

Deprecated.

API for getting the SIP status

Parameters:

sipId -

Returns:

Sip status stage

getSIPStatusInfo

com.exlibris.repository.persistence.sip.SIPStatusInfo getSIPStatusInfo(java.lang.String SipId)
                                                                       throws java.lang.Exception

API for getting the SIP Info

The service returns SipStatusInfo that holds the Module the sip is currently in, including Status and Stage. The Status and Stage depends on the Module value according to the following conditions:

If the Module = "DEP" then Status can be one of the following options: DRAFT, REJECTED, DECLINED, APPROVED, ERROR, INPROCESS, INCOMPLETE, DELETED
The Stage can be one of the following options: "Deposit","Loading","Validation","Assessor","Arranger","Approver","Bytestream","Enrichment","ToPermanent","Finished"

Else if the Module = "REP" / "PER" then Status can be one of the following options: CREATED, WAITING, ACTIVE, REJECT, DECLINE, REJECT_CONTENT, FINISHED, IN_HUMAN_STAGE, IN_TA
The Stage can be one of the following options: "Deposit","Loading","Validation","Assessor","Arranger","Approver","Bytestream","Enrichment","ToPermanent","Finished"

Else if the Module = "NONE" then Status = DELETED
The Stage can be one of the following options: "Deposit","Loading","Validation","Assessor","Arranger","Approver","Bytestream","Enrichment","ToPermanent","Finished"

Parameters:

SipId -

Returns:

SipStatusInfo Module, Status, Stage

Throws:

java.lang.Exception

getSipIEs

java.lang.String getSipIEs(java.lang.String sipId)

API for getting the IEs related to a certain SIP

Parameters:

sipId -

Returns:

CSV string of IE numbers.