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

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.util.List<SIPStatusInfo>	getSIPsStatusInfo(java.util.List<java.lang.String> sipId, boolean numberOfIEs) API for getting a list of SipStatusInfo objects by list of SIP IDs
java.lang.String	getSipStatus(java.lang.String sipId) Deprecated.
SIPStatusInfo	getSIPStatusInfo(java.lang.String SipId, boolean numberOfIEs) API for getting the SIP Info
java.util.List<SIPStatusInfo>	getSIPStatusInfoByExternalId(java.lang.String externalSystem, java.lang.String externalId, boolean numberOfIEs) API for getting the SIP Status Info by external ID

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

SIPStatusInfo getSIPStatusInfo(java.lang.String SipId,
                               boolean numberOfIEs)
                        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, Stage, External Id, External system, and its number of IEs if the numberOfIEs flag is set to true. 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: "null","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: "null","Deposit","Loading","Validation","Assessor","Arranger","Approver","Bytestream","Enrichment","ToPermanent","Finished"

Else if the Module = "NONE" then Status = DELETED
The Stage will be: "null"

Parameters:

SipId -

numberOfIEs - a boolean flag, false by default (optional)

Returns:

SipStatusInfo SipId, Module, Status, Stage, External Id, External System (, number of IEs)

Throws:

java.lang.Exception

getSIPsStatusInfo

java.util.List<SIPStatusInfo> getSIPsStatusInfo(java.util.List<java.lang.String> sipId,
                                                boolean numberOfIEs)
                                         throws java.lang.Exception

API for getting a list of SipStatusInfo objects by list of SIP IDs

The service gets a list of SIP IDs and returns a list of SipStatusInfo objects. Each object holds the Module the SIP is currently in, including Status, Stage, External Id, External system and its number of IEs if the numberOfIEs flag is set to true. The Status and Stage depends on the Module value according to the conditions described for the getSIPStatusInfo method. In case the SIP isn't found, the corresponding SipStatusInfo object will hold an error. Limited to 1000 SIP IDs. When the limit exceeded, an exception is thrown.

Parameters:

sipId - A list of SIPs id

numberOfIEs - a boolean flag, false by default (optional)

Returns:

A list of SipStatusInfo objects

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.

getSIPStatusInfoByExternalId

java.util.List<SIPStatusInfo> getSIPStatusInfoByExternalId(java.lang.String externalSystem,
                                                           java.lang.String externalId,
                                                           boolean numberOfIEs)
                                                    throws java.lang.Exception

API for getting the SIP Status Info by external ID

The service returns one or more SipStatusInfo objects that hold the Module the SIP is currently in, including Status, Stage, External Id, External system and its number of IEs if the numberOfIEs flag is set to true. The Status and Stage depends on the Module value according to the conditions described for the getSIPStatusInfo method.

Parameters:

externalSystem - an external system identifier (optional)

externalId - an external ID assigned to the SIP (mandatory)

numberOfIEs - a boolean flag, false by default (optional)

Returns:

SipStatusInfo

Throws:

java.lang.Exception