com.ca.dso.itpam.webservice.client
Class ItpamWebServiceClient

java.lang.Object
  extended by com.ca.dso.itpam.webservice.client.ItpamWebServiceClient

public abstract class ItpamWebServiceClient
extends java.lang.Object


Nested Class Summary
 class ItpamWebServiceClient.ItpamAttachment
          Abstract ITPAM attachment class extended by version specific classes
 class ItpamWebServiceClient.ItpamEntityNotFoundException
          Exception class instantiated and thrown when an ITPAM entity is inaccessible or not found.
 class ItpamWebServiceClient.ItpamInteraction
          Abstract ITPAM interaction class extended by version specific classes
 class ItpamWebServiceClient.ItpamMethodNotSupportedException
          Exception class instantiated and thrown when a web service method is not supported.
 class ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
          Exception class instantiated and thrown when a required parameter is missing or invalid.
 class ItpamWebServiceClient.ItpamProcessLogEntry
          Abstract ITPAM process log entry class extended by version specific concrete classes
 class ItpamWebServiceClient.ItpamProcessStatus
          Abstract ITPAM process status class extended by version specific concrete classes
 class ItpamWebServiceClient.ItpamStartRequestForm
          Abstract ITPAM start request status class extended by version specific concrete classes
 class ItpamWebServiceClient.ItpamStartRequestStatus
          Abstract ITPAM start request status class extended by version specific concrete classes
 class ItpamWebServiceClient.ItpamStringToDateException
          Exception class instantiated and thrown when an string to date conversion exception is thrown.
 class ItpamWebServiceClient.ItpamUnknownHostException
          Exception class instantiated and thrown when a user does not have permissions to complete the operation.
 class ItpamWebServiceClient.ItpamUserPermissionsException
          Exception class instantiated and thrown when a user does not have permissions to complete the operation.
 class ItpamWebServiceClient.ItpamWebServiceClientException
          Exception class instantiated and thrown when an unexpected exception is detected.
 
Field Summary
static java.lang.String CACOPYRIGHT
          Public string constant required by CA
 
Method Summary
abstract  void abortProcess(java.lang.String strProcessId)
          Abort process specified by process ID.
abstract  void approvePendingInteraction(java.lang.String strInteractionId, java.util.Properties propertiesParameters)
          Approve pending user interaction request.
abstract  void deleteArchivedInstances(java.lang.String strStartDate, java.lang.String strEndDate)
          Delete archived instances in date range specified.
abstract  void deleteAttachment(java.lang.String strAttachmentId)
          Delete specified attachment.
abstract  void deleteAttachments(java.lang.String[] aryAttachmentIds)
          Delete specified attachments.
abstract  java.util.Vector<ItpamWebServiceClient.ItpamAttachment> getAttachments(java.lang.String strContentId, java.lang.String strContentType)
          Get information for existing attachments.
abstract  ItpamWebServiceClient.ItpamInteraction getPendingInteraction(java.lang.String strInteractionId)
          Get information related to pending user interaction specified.
abstract  java.util.Vector<ItpamWebServiceClient.ItpamInteraction> getPendingInteractions()
          Get pending interaction information.
abstract  java.util.Vector<ItpamWebServiceClient.ItpamProcessLogEntry> getProcessLogs(java.lang.String strProcessId, java.lang.String strLevel, java.lang.String[] aryCategories)
          Get process logs.
abstract  java.util.Vector<ItpamWebServiceClient.ItpamInteraction> getProcessPendingInteractions(java.lang.String strProcessId)
          Get list of pending interactions related to the process ID specified.
abstract  ItpamWebServiceClient.ItpamProcessStatus getProcessStatus(java.lang.String strProcessId)
          Get current status of process specified.
abstract  java.lang.String getServerStatus()
          Get current status of the ITPAM web service server.
abstract  java.util.Vector<ItpamWebServiceClient.ItpamStartRequestForm> getStartRequestForms(java.lang.String[] aryKeywords, java.lang.String strSearchPath, boolean bolRecursive)
          Search for and return available start request forms.
abstract  java.lang.String getStartRequestProcessReferenced(java.lang.String strStartRequestName, java.lang.String strStartRequestPath)
          Get process name referenced by the start request form specified.
abstract  ItpamWebServiceClient.ItpamStartRequestStatus getStartRequestStatus(java.lang.String strStartRequestId)
          Get start request status object that includes the following information:
- Earliest Start Time
- End Time
- Interaction ID
- Referenced Process
- Start Time
- State
abstract  void importObject(java.lang.String strSourcePathFileName, java.lang.String strTargetLibraryPathName, boolean bolMakeAvailable, boolean bolMakeCurrent)
          Import file into ITPAM library.
abstract  void rejectPendingInteraction(java.lang.String strInteractionId)
          Reject pending user interaction request.
abstract  void resumeProcess(java.lang.String strProcessId)
          Resume process specified by process ID.
abstract  java.lang.String startProcess(java.lang.String strProcessName, java.util.Properties propertiesParameters, java.lang.String strStartDate, java.lang.String strStartTime, java.lang.String strParameterNameAttachments, java.util.Properties propertiesAttachments)
          Start process specified.
abstract  java.lang.String startRequest(java.lang.String strName, java.lang.String strPath, java.util.Properties propertiesParameters, java.lang.String strStartDate, java.lang.String strStartTime, java.lang.String strParameterNameAttachments, java.util.Properties propertiesAttachments)
          Initiate process via start request form.
abstract  void suspendProcess(java.lang.String strProcessId)
          Suspend process specified by process ID.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CACOPYRIGHT

public static final java.lang.String CACOPYRIGHT
Public string constant required by CA

See Also:
Constant Field Values
Method Detail

abortProcess

public abstract void abortProcess(java.lang.String strProcessId)
                           throws java.lang.Exception,
                                  ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                  ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                  ItpamWebServiceClient.ItpamStringToDateException,
                                  ItpamWebServiceClient.ItpamEntityNotFoundException,
                                  ItpamWebServiceClient.ItpamUserPermissionsException,
                                  ItpamWebServiceClient.ItpamUnknownHostException,
                                  ItpamWebServiceClient.ItpamWebServiceClientException
Abort process specified by process ID. Note: Method not supported for ITPAM 2.1 (see pending issue 18894147-1).

Parameters:
strProcessId - - String process ID value
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

approvePendingInteraction

public abstract void approvePendingInteraction(java.lang.String strInteractionId,
                                               java.util.Properties propertiesParameters)
                                        throws java.lang.Exception,
                                               ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                               ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                               ItpamWebServiceClient.ItpamStringToDateException,
                                               ItpamWebServiceClient.ItpamEntityNotFoundException,
                                               ItpamWebServiceClient.ItpamUserPermissionsException,
                                               ItpamWebServiceClient.ItpamUnknownHostException,
                                               ItpamWebServiceClient.ItpamWebServiceClientException
Approve pending user interaction request.

Parameters:
lInteractionId - - String user interaction ID value
propertiesParameters - - Properties object encapsulating parameter names and values
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

deleteArchivedInstances

public abstract void deleteArchivedInstances(java.lang.String strStartDate,
                                             java.lang.String strEndDate)
                                      throws java.lang.Exception,
                                             ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                             ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                             ItpamWebServiceClient.ItpamStringToDateException,
                                             ItpamWebServiceClient.ItpamEntityNotFoundException,
                                             ItpamWebServiceClient.ItpamUserPermissionsException,
                                             ItpamWebServiceClient.ItpamUnknownHostException,
                                             ItpamWebServiceClient.ItpamWebServiceClientException
Delete archived instances in date range specified. Note: Method not supported for ITPAM 2.1.

Parameters:
strContentId - - String set to start date of date range
strContentType - - String set to end date of date rangef

Supported date formats 'yyyy-MM-dd', 'yyyy/MM/dd', 'MM-dd-yyyy', 'MM/dd/yyyy'
Supported time formats 'hh:mm:ss', 'hh:mm'
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

deleteAttachment

public abstract void deleteAttachment(java.lang.String strAttachmentId)
                               throws java.lang.Exception,
                                      ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                      ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                      ItpamWebServiceClient.ItpamStringToDateException,
                                      ItpamWebServiceClient.ItpamEntityNotFoundException,
                                      ItpamWebServiceClient.ItpamUserPermissionsException,
                                      ItpamWebServiceClient.ItpamUnknownHostException,
                                      ItpamWebServiceClient.ItpamWebServiceClientException
Delete specified attachment.

Parameters:
arayAttachmentIds - - String set to attachment IDs to be deleted
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

deleteAttachments

public abstract void deleteAttachments(java.lang.String[] aryAttachmentIds)
                                throws java.lang.Exception,
                                       ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                       ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                       ItpamWebServiceClient.ItpamStringToDateException,
                                       ItpamWebServiceClient.ItpamEntityNotFoundException,
                                       ItpamWebServiceClient.ItpamUserPermissionsException,
                                       ItpamWebServiceClient.ItpamUnknownHostException,
                                       ItpamWebServiceClient.ItpamWebServiceClientException
Delete specified attachments.

Parameters:
arayAttachmentIds - - Array of String attachment IDs to be deleted
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

getAttachments

public abstract java.util.Vector<ItpamWebServiceClient.ItpamAttachment> getAttachments(java.lang.String strContentId,
                                                                                       java.lang.String strContentType)
                                                                                throws java.lang.Exception,
                                                                                       ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                                                                       ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                                                                       ItpamWebServiceClient.ItpamStringToDateException,
                                                                                       ItpamWebServiceClient.ItpamEntityNotFoundException,
                                                                                       ItpamWebServiceClient.ItpamUserPermissionsException,
                                                                                       ItpamWebServiceClient.ItpamUnknownHostException,
                                                                                       ItpamWebServiceClient.ItpamWebServiceClientException
Get information for existing attachments.

Parameters:
strContentId - - String set to content ID or null
strContentType - - String set to content Type or null
Returns:
Vector of ItpamAttachmentInfo objects
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

getPendingInteraction

public abstract ItpamWebServiceClient.ItpamInteraction getPendingInteraction(java.lang.String strInteractionId)
                                                                      throws java.lang.Exception,
                                                                             ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                                                             ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                                                             ItpamWebServiceClient.ItpamStringToDateException,
                                                                             ItpamWebServiceClient.ItpamEntityNotFoundException,
                                                                             ItpamWebServiceClient.ItpamUserPermissionsException,
                                                                             ItpamWebServiceClient.ItpamUnknownHostException,
                                                                             ItpamWebServiceClient.ItpamWebServiceClientException
Get information related to pending user interaction specified.

Parameters:
strInteractionId - - String set to pending user interaction request ID
Returns:
ItpamInteraction object
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

getPendingInteractions

public abstract java.util.Vector<ItpamWebServiceClient.ItpamInteraction> getPendingInteractions()
                                                                                         throws java.lang.Exception,
                                                                                                ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                                                                                ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                                                                                ItpamWebServiceClient.ItpamStringToDateException,
                                                                                                ItpamWebServiceClient.ItpamEntityNotFoundException,
                                                                                                ItpamWebServiceClient.ItpamUserPermissionsException,
                                                                                                ItpamWebServiceClient.ItpamUnknownHostException,
                                                                                                ItpamWebServiceClient.ItpamWebServiceClientException
Get pending interaction information.

Returns:
Vector of ItpamInteraction objects.
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

getProcessLogs

public abstract java.util.Vector<ItpamWebServiceClient.ItpamProcessLogEntry> getProcessLogs(java.lang.String strProcessId,
                                                                                            java.lang.String strLevel,
                                                                                            java.lang.String[] aryCategories)
                                                                                     throws java.lang.Exception,
                                                                                            ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                                                                            ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                                                                            ItpamWebServiceClient.ItpamStringToDateException,
                                                                                            ItpamWebServiceClient.ItpamEntityNotFoundException,
                                                                                            ItpamWebServiceClient.ItpamUserPermissionsException,
                                                                                            ItpamWebServiceClient.ItpamUnknownHostException,
                                                                                            ItpamWebServiceClient.ItpamWebServiceClientException
Get process logs. Note: Method not supported for ITPAM 2.1.

Parameters:
lProcessId - - long set to process ID
strLevel - - String set to minimum severity level to be returned (Valid Levels: Level: error ,warning, notice, and normal; If the user specifies an invalid level, it will be treated as normal (the lowest level)
aryCategores - - Array of Strings set to log categories (i.e. Operator, Process, userMsg; ignored if invalid string specified)
Returns:
Vector of ItpamProcessLogEntry objects
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

getProcessPendingInteractions

public abstract java.util.Vector<ItpamWebServiceClient.ItpamInteraction> getProcessPendingInteractions(java.lang.String strProcessId)
                                                                                                throws java.lang.Exception,
                                                                                                       ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                                                                                       ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                                                                                       ItpamWebServiceClient.ItpamStringToDateException,
                                                                                                       ItpamWebServiceClient.ItpamEntityNotFoundException,
                                                                                                       ItpamWebServiceClient.ItpamUserPermissionsException,
                                                                                                       ItpamWebServiceClient.ItpamUnknownHostException,
                                                                                                       ItpamWebServiceClient.ItpamWebServiceClientException
Get list of pending interactions related to the process ID specified.

Parameters:
lProcessId - - long set to process ID
Returns:
Vector of ItpamInteraction objects
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

getProcessStatus

public abstract ItpamWebServiceClient.ItpamProcessStatus getProcessStatus(java.lang.String strProcessId)
                                                                   throws java.lang.Exception,
                                                                          ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                                                          ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                                                          ItpamWebServiceClient.ItpamStringToDateException,
                                                                          ItpamWebServiceClient.ItpamEntityNotFoundException,
                                                                          ItpamWebServiceClient.ItpamUserPermissionsException,
                                                                          ItpamWebServiceClient.ItpamUnknownHostException,
                                                                          ItpamWebServiceClient.ItpamWebServiceClientException
Get current status of process specified.

Parameters:
strProcessId - - String set to process ID
Returns:
ItpamProcessStatus object encapsulating status properties
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

getServerStatus

public abstract java.lang.String getServerStatus()
                                          throws java.lang.Exception,
                                                 ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                                 ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                                 ItpamWebServiceClient.ItpamStringToDateException,
                                                 ItpamWebServiceClient.ItpamEntityNotFoundException,
                                                 ItpamWebServiceClient.ItpamUserPermissionsException,
                                                 ItpamWebServiceClient.ItpamUnknownHostException,
                                                 ItpamWebServiceClient.ItpamWebServiceClientException
Get current status of the ITPAM web service server.

Returns:
String set to server status
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

getStartRequestForms

public abstract java.util.Vector<ItpamWebServiceClient.ItpamStartRequestForm> getStartRequestForms(java.lang.String[] aryKeywords,
                                                                                                   java.lang.String strSearchPath,
                                                                                                   boolean bolRecursive)
                                                                                            throws java.lang.Exception,
                                                                                                   ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                                                                                   ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                                                                                   ItpamWebServiceClient.ItpamStringToDateException,
                                                                                                   ItpamWebServiceClient.ItpamEntityNotFoundException,
                                                                                                   ItpamWebServiceClient.ItpamUserPermissionsException,
                                                                                                   ItpamWebServiceClient.ItpamUnknownHostException,
                                                                                                   ItpamWebServiceClient.ItpamWebServiceClientException
Search for and return available start request forms.

Parameters:
aryKeywords - - Array of Strings set to to keywords to used in search filter (Note: Ignored for version 2.1)
strSearchPath - - String set to search path to be set as the root folder of the search (Note: Ignored for version 2.1)
bolRecursive - - boolean set to true to search through child folders of the root folder specified (Note: Ignored for version 2.1)
Returns:
Vector of ItpamStartRequestForm objects
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

getStartRequestProcessReferenced

public abstract java.lang.String getStartRequestProcessReferenced(java.lang.String strStartRequestName,
                                                                  java.lang.String strStartRequestPath)
                                                           throws java.lang.Exception,
                                                                  ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                                                  ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                                                  ItpamWebServiceClient.ItpamStringToDateException,
                                                                  ItpamWebServiceClient.ItpamEntityNotFoundException,
                                                                  ItpamWebServiceClient.ItpamUserPermissionsException,
                                                                  ItpamWebServiceClient.ItpamUnknownHostException,
                                                                  ItpamWebServiceClient.ItpamWebServiceClientException
Get process name referenced by the start request form specified.

Parameters:
strStartRequestName - - String set to start request form name
strStartRequestPath - - String set to start request form library path
Returns:
String set to fully qualified process name referenced by the start request form specified
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

getStartRequestStatus

public abstract ItpamWebServiceClient.ItpamStartRequestStatus getStartRequestStatus(java.lang.String strStartRequestId)
                                                                             throws java.lang.Exception,
                                                                                    ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                                                                    ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                                                                    ItpamWebServiceClient.ItpamStringToDateException,
                                                                                    ItpamWebServiceClient.ItpamEntityNotFoundException,
                                                                                    ItpamWebServiceClient.ItpamUserPermissionsException,
                                                                                    ItpamWebServiceClient.ItpamUnknownHostException,
                                                                                    ItpamWebServiceClient.ItpamWebServiceClientException
Get start request status object that includes the following information:
- Earliest Start Time
- End Time
- Interaction ID
- Referenced Process
- Start Time
- State

Parameters:
lStartRequestInteractionId - - Long set to start request interaction ID
Returns:
ItpamStartRequestStatus object that exposes methods to detailed status information
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

importObject

public abstract void importObject(java.lang.String strSourcePathFileName,
                                  java.lang.String strTargetLibraryPathName,
                                  boolean bolMakeAvailable,
                                  boolean bolMakeCurrent)
                           throws java.lang.Exception,
                                  ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                  ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                  ItpamWebServiceClient.ItpamStringToDateException,
                                  ItpamWebServiceClient.ItpamEntityNotFoundException,
                                  ItpamWebServiceClient.ItpamUserPermissionsException,
                                  ItpamWebServiceClient.ItpamUnknownHostException,
                                  ItpamWebServiceClient.ItpamWebServiceClientException
Import file into ITPAM library. Note: Method not supported (see pending issue 18817384-1).

Parameters:
strSourcePathFileName - - String set to path and file name of file to be imported
strTargetLibraryPathName - - String set to target library path and object name
bolMakeAvailable - - boolean set to true if imported file should be flagged as available
bolMakeCurrent - - boolean set to true if imported file should be flagged as the current version
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

rejectPendingInteraction

public abstract void rejectPendingInteraction(java.lang.String strInteractionId)
                                       throws java.lang.Exception,
                                              ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                              ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                              ItpamWebServiceClient.ItpamStringToDateException,
                                              ItpamWebServiceClient.ItpamEntityNotFoundException,
                                              ItpamWebServiceClient.ItpamUserPermissionsException,
                                              ItpamWebServiceClient.ItpamUnknownHostException,
                                              ItpamWebServiceClient.ItpamWebServiceClientException
Reject pending user interaction request.

Parameters:
lInteractionId - - String user interaction ID value
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

resumeProcess

public abstract void resumeProcess(java.lang.String strProcessId)
                            throws java.lang.Exception,
                                   ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                   ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                   ItpamWebServiceClient.ItpamStringToDateException,
                                   ItpamWebServiceClient.ItpamEntityNotFoundException,
                                   ItpamWebServiceClient.ItpamUserPermissionsException,
                                   ItpamWebServiceClient.ItpamUnknownHostException,
                                   ItpamWebServiceClient.ItpamWebServiceClientException
Resume process specified by process ID. Note: Method not supported for ITPAM 2.1 (see pending issue 18894147-1).

Parameters:
strProcessId - - String process ID value
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

startProcess

public abstract java.lang.String startProcess(java.lang.String strProcessName,
                                              java.util.Properties propertiesParameters,
                                              java.lang.String strStartDate,
                                              java.lang.String strStartTime,
                                              java.lang.String strParameterNameAttachments,
                                              java.util.Properties propertiesAttachments)
                                       throws java.lang.Exception,
                                              ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                              ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                              ItpamWebServiceClient.ItpamStringToDateException,
                                              ItpamWebServiceClient.ItpamEntityNotFoundException,
                                              ItpamWebServiceClient.ItpamUserPermissionsException,
                                              ItpamWebServiceClient.ItpamUnknownHostException,
                                              ItpamWebServiceClient.ItpamWebServiceClientException
Start process specified.

Parameters:
strProcessName - - String set to fully qualified process name
propertiesParameters - - Properties object encapsulating parameter names and values or null
strStartDate - - String set to start date ('yyyy-MM-dd', 'yyyy/MM/dd', 'MM-dd-yyyy', 'MM/dd/yyyy') or null. Required if parameter 'strStartTime' is specified
strStartTime - - String set to time ('hh:mm:ss', 'hh:mm') or null
strParameterNameAttachments - - String set to parameter name attachments will be linked or null. Required if attachment properties are specified.
propertiesAttachments - - Properties object encapsulating attachment name and URI name/value pairs
Returns:
String set to process ID
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

startRequest

public abstract java.lang.String startRequest(java.lang.String strName,
                                              java.lang.String strPath,
                                              java.util.Properties propertiesParameters,
                                              java.lang.String strStartDate,
                                              java.lang.String strStartTime,
                                              java.lang.String strParameterNameAttachments,
                                              java.util.Properties propertiesAttachments)
                                       throws java.lang.Exception,
                                              ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                              ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                              ItpamWebServiceClient.ItpamStringToDateException,
                                              ItpamWebServiceClient.ItpamEntityNotFoundException,
                                              ItpamWebServiceClient.ItpamUserPermissionsException,
                                              ItpamWebServiceClient.ItpamUnknownHostException,
                                              ItpamWebServiceClient.ItpamWebServiceClientException
Initiate process via start request form.

Parameters:
strName - - String set to start request form name
strPath - - String set to start request form library path
propertiesParameters - - Properties object encapsulating parameter names and values or null
strStartDate - - String set to start date ('yyyy-MM-dd', 'yyyy/MM/dd', 'MM-dd-yyyy', 'MM/dd/yyyy') or null
strStartTime - - String set to time ('hh:mm:ss', 'hh:mm') or null
strParameterNameAttachments - - String set to parameter name attachments will be linked or null. Required if attachment properties are specified.
propertiesAttachments - - Properties object encapsulating attachment name and URI name/value pairs
Returns:
String set to process ID
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception

suspendProcess

public abstract void suspendProcess(java.lang.String strProcessId)
                             throws java.lang.Exception,
                                    ItpamWebServiceClient.ItpamMethodNotSupportedException,
                                    ItpamWebServiceClient.ItpamParameterMissingOrInvalidException,
                                    ItpamWebServiceClient.ItpamStringToDateException,
                                    ItpamWebServiceClient.ItpamEntityNotFoundException,
                                    ItpamWebServiceClient.ItpamUserPermissionsException,
                                    ItpamWebServiceClient.ItpamUnknownHostException,
                                    ItpamWebServiceClient.ItpamWebServiceClientException
Suspend process specified by process ID. Note: Method not supported for ITPAM 2.1 (see pending issue 18894147-1).

Parameters:
strProcessId - - String process ID value
Throws:
ItpamWebServiceClient.ItpamEntityNotFoundException
ItpamWebServiceClient.ItpamMethodNotSupportedException
ItpamWebServiceClient.ItpamParameterMissingOrInvalidException
ItpamWebServiceClient.ItpamStringToDateException
ItpamWebServiceClient.ItpamUnknownHostException
ItpamWebServiceClient.ItpamUserPermissionsException
ItpamWebServiceClient.ItpamWebServiceClientException
java.lang.Exception