com.exlibris.digitool.repository.ifc

Interface DataManagerServicesWS

All Superinterfaces:

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

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

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	abortProcess(java.lang.String pdsHandle, long processExecutionId) API for aborting a running active process execution.
com.exlibris.repository.procauto.ExportEntityInfo	exportIE(java.lang.String pdsHandle, java.lang.String pid, java.lang.String path) API for exporting IE.
java.util.List<com.exlibris.repository.maintenance.Process>	getMaintenanceProcessList(java.lang.String pdsHandle) API for getting processes list.
ProcessExecutionStatusInfo	getProcessExecutionStatus(java.lang.String pdsHandle, long processExecutionId) API for retrieving the current status and relevant information for a given process execution.
SetMembers	getSetMembers(java.lang.String pdsHandle, long setId) API for getting set info.
long	runProcess(java.lang.String pdsHandle, long processId) API for creating a new execution for the provided process to be run in immediate mode (run once) and returns the processExecutionId.
java.lang.Long	runProcessOnPids(java.lang.String pdsHandle, long processId, java.lang.String[] pidList) API for running process on a given array of pids.
SetMembersInfo	updateSetMembers(java.lang.String pdsHandle, long setId, java.lang.String[] ieIds) API for updating set Members.

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

getHeartBit

Method Detail

updateSetMembers

SetMembersInfo updateSetMembers(java.lang.String pdsHandle,
                                long setId,
                                java.lang.String[] ieIds)
                         throws UserAuthorizeException,
                                com.exlibris.core.sdk.exceptions.SetNotValidException

API for updating set Members. First clears existing members in the given itemized set and will than update an existing itemized set with the provided list of IE PIDs.

Parameters:

pdsHandle - of a logged-in user

setId - of the existing itemize set to be updated

ieIds - of Pids array that will updated to be members of the set

Returns:

SetMembersInfo

Throws:

com.exlibris.core.sdk.exceptions.SetNotValidException

UserAuthorizeException

getProcessExecutionStatus

ProcessExecutionStatusInfo getProcessExecutionStatus(java.lang.String pdsHandle,
                                                     long processExecutionId)
                                              throws UserAuthorizeException,
                                                     com.exlibris.core.sdk.exceptions.ProcessException

API for retrieving the current status and relevant information for a given process execution.

Parameters:

pdsHandle - of a logged-in user

processExecutionId - of the existing Process Execution

Returns:

ProcessExecutionStatusInfo

Throws:

UserAuthorizeException

com.exlibris.core.sdk.exceptions.ProcessException

runProcess

long runProcess(java.lang.String pdsHandle,
                long processId)
         throws UserAuthorizeException,
                com.exlibris.core.sdk.exceptions.ProcessException

API for creating a new execution for the provided process to be run in immediate mode (run once) and returns the processExecutionId.

Parameters:

pdsHandle - of a logged-in user

processId - of the existing Process

Returns:

long - processExecutionId to be monitored by getProcessExecutionStatus

Throws:

UserAuthorizeException

com.exlibris.core.sdk.exceptions.ProcessException

exportIE

com.exlibris.repository.procauto.ExportEntityInfo exportIE(java.lang.String pdsHandle,
                                                           java.lang.String pid,
                                                           java.lang.String path)
                                                    throws UserAuthorizeException,
                                                           com.exlibris.core.sdk.exceptions.ProcessException,
                                                           com.exlibris.core.sdk.exceptions.InvalidIEException

API for exporting IE.

Parameters:

pdsHandle - of a logged-in user

pid - of IE which will be exported

path - for exported IE - can be relative, absolute or null

Returns:

ExportEntityInfo

Throws:

UserAuthorizeException

com.exlibris.core.sdk.exceptions.ProcessException

com.exlibris.core.sdk.exceptions.InvalidIEException

getMaintenanceProcessList

java.util.List<com.exlibris.repository.maintenance.Process> getMaintenanceProcessList(java.lang.String pdsHandle)
                                                                               throws UserAuthorizeException

API for getting processes list. List contains all active maintenance processes.

Parameters:

pdsHandle - of a logged-in user

Returns:

List of Process

Throws:

UserAuthorizeException

getSetMembers

SetMembers getSetMembers(java.lang.String pdsHandle,
                         long setId)
                  throws UserAuthorizeException,
                         com.exlibris.core.sdk.exceptions.SetNotValidException

API for getting set info. Set info contains general information about the set and also some info about the IEs and files within the set.

Parameters:

pdsHandle - of a logged-in user

setId - of requested set

Returns:

SetMembers

Throws:

UserAuthorizeException

com.exlibris.core.sdk.exceptions.SetNotValidException

runProcessOnPids

java.lang.Long runProcessOnPids(java.lang.String pdsHandle,
                                long processId,
                                java.lang.String[] pidList)
                         throws UserAuthorizeException,
                                com.exlibris.core.sdk.exceptions.ProcessException

API for running process on a given array of pids. The set which is associated with the given process will be ignored.

Parameters:

pdsHandle - of a logged-in user

processId - of process to run

pidList - array of pids

Returns:

long - processExecutionId to be monitored by getProcessExecutionStatus

Throws:

UserAuthorizeException

com.exlibris.core.sdk.exceptions.ProcessException

abortProcess

java.lang.Integer abortProcess(java.lang.String pdsHandle,
                               long processExecutionId)
                        throws UserAuthorizeException,
                               com.exlibris.core.sdk.exceptions.ProcessException

API for aborting a running active process execution.

Parameters:

pdsHandle - of a logged-in user

processExecutionId - of the process execution to be aborted

Throws:

UserAuthorizeException

com.exlibris.core.sdk.exceptions.ProcessException