DDMManagementService (api-interfaces 11.8.0.232 API)

```
public interface DDMManagementService
```
Services to analyze and view the progress, results, and errors of the Universal Discovery run.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abortRun(DiscoveryContext context)` Stops execution of all tasks associated with the specified context.
`void`	`activate(DiscoveryContext context)` Activates the jobs (discovery, population or activity) defined by the discovery context.
`void`	`activateJobs(HashSet<String> jobs)` Deprecated. as of UD 10.20, replaced by `activate(com.hp.ucmdb.api.discovery.types.DiscoveryContext)`
`void`	`clearProbeResultsCacheByDiscoveryContext(DiscoveryContext context)` Clears probe results data for collection of jobs defined by the discovery context Doesn't clear last successful invocation
`void`	`deactivate(DiscoveryContext context)` Deactivates the discovery, population, or activity jobs that are defined by the discovery context.
`void`	`deactivateJobs(HashSet<String> jobs)` Deprecated. as of UD 10.20, replaced by `deactivate(com.hp.ucmdb.api.discovery.types.DiscoveryContext)`
`Collection<CIErrorData>`	`getCIsErrorData(ErrorID errorId)` Returns a collection of CIErrorData with a specified errorId.
`ContextFactory`	`getContextFactory()` Returns the factory that creates `DiscoveryContext` objects.
`CredentialErrorType`	`getCredentialError(ErrorStatus error)` Returns the credential related errors that occurred during the last Universal Discovery run.
`DiagnosticInfo`	`getDiagnosticInfo(String jobId, UcmdbId triggerCiId)` Returns the DiagnosticInfo for the execution of the jobId against the specified triggerCiId.
`DiagnosticInfo`	`getDiagnosticInfo(String jobId, UcmdbId triggerCiId, long timeout)` Returns the DiagnosticInfo for the execution of the jobId against the specified triggerCiId.
`DiscoveryFactory`	`getDiscoveryFactory()` Returns the factory that creates the objects required by this service.
`DiscoveryProgressData`	`getDiscoveryProgressDashBoard(String... cis)` get discovery progress widget data
`Collection<ErrorStatus>`	`getErrors()` Returns the errors that occurred during the last Universal Discovery run.
`Collection<ErrorStatus>`	`getErrors(DiscoveryContext context)` Returns the errors that occurred within the specified scope during the last Universal Discovery run.
`Collection<ErrorStatus>`	`getErrors(DiscoveryContext context, ErrorsFilter filter)` Returns the errors that occurred within the specified scope during the last Universal Discovery run and that match the specified filter.
`Collection<ErrorStatus>`	`getErrors(ErrorsFilter filter)` Returns the errors that occurred during the last Universal Discovery run and that match the specified filter.
`DiscoveryProgress`	`getProgress()` Returns the progress of the Universal Discovery run.
`DiscoveryProgress`	`getProgress(DiscoveryContext context)` Deprecated.
`void`	`pause(DiscoveryContext context)` Pauses the jobs defined by the discovery context.
`void`	`reRun(DiscoveryContext context)` Sets all tasks associated with the specified context to be re-executed.
`void`	`resume(DiscoveryContext context)` Resumes the jobs defined by the discovery context Supported by service discovery context only

- Method Detail
  - getProgress
```
DiscoveryProgress getProgress()
```
    Returns the progress of the Universal Discovery run. vity
    
    Returns:
    
    an object that represents the progress of the Universal Discovery run.
  - getProgress
```
@Deprecated
DiscoveryProgress getProgress(DiscoveryContext context)
```
    Deprecated.
    
    Returns the progress of processing the specified context within the Universal Discovery run.
    
    Parameters:
    
    context - the scope on which the information is required.
    
    Returns:
    
    an object that represents the Progress of the Universal Discovery run on the specified scope.
  - getErrors
```
Collection<ErrorStatus> getErrors()
```
    Returns the errors that occurred during the last Universal Discovery run.
    
    Returns:
    
    the ErrorStatus objects from the last Universal Discovery run.
  - getCredentialError
```
CredentialErrorType getCredentialError(ErrorStatus error)
```
    Returns the credential related errors that occurred during the last Universal Discovery run.
    
    Parameters:
    
    error - the error status
    
    Returns:
    
    the credential related error status
  - getErrors
```
Collection<ErrorStatus> getErrors(DiscoveryContext context)
```
    Returns the errors that occurred within the specified scope during the last Universal Discovery run.
    
    Parameters:
    
    context - the scope on which the information is required.
    
    Returns:
    
    the ErrorStatus objects from the specified context of the last Universal Discovery run.
  - getErrors
```
Collection<ErrorStatus> getErrors(DiscoveryContext context,
                                  ErrorsFilter filter)
```
    Returns the errors that occurred within the specified scope during the last Universal Discovery run and that match the specified filter.
    
    Parameters:
    
    context - the scope on which the information is required.
    
    filter - restrictions on the errors to be returned.
    
    Returns:
    
    the ErrorStatus objects from the specified scope of the last Universal Discovery run that match the filter.
  - getErrors
```
Collection<ErrorStatus> getErrors(ErrorsFilter filter)
```
    Returns the errors that occurred during the last Universal Discovery run and that match the specified filter.
    
    Parameters:
    
    filter - restrictions on the errors to be returned.
    
    Returns:
    
    the ErrorStatus objects from the last Universal Discovery run that match the filter.
  - getCIsErrorData
```
Collection<CIErrorData> getCIsErrorData(ErrorID errorId)
```
    Returns a collection of CIErrorData with a specified errorId.
    
    Parameters:
    
    errorId - the error ID.
    
    Returns:
    
    the CIs' data.
  - getDiagnosticInfo
```
DiagnosticInfo getDiagnosticInfo(String jobId,
                                 UcmdbId triggerCiId)
                          throws TimeoutException
```
    Returns the DiagnosticInfo for the execution of the jobId against the specified triggerCiId.
    
    Parameters:
    
    jobId - the desired DiagnosticInfo was collected during the execution of this job.
    
    triggerCiId - the UcmdbId of the CI that is the subject of the DiagnosticInfo.
    
    Returns:
    
    the data regarding the execution of the input job against the input CI.
    
    Throws:
    
    TimeoutException
  - getDiagnosticInfo
```
DiagnosticInfo getDiagnosticInfo(String jobId,
                                 UcmdbId triggerCiId,
                                 long timeout)
                          throws TimeoutException
```
    Returns the DiagnosticInfo for the execution of the jobId against the specified triggerCiId.
    
    Parameters:
    
    jobId - the of the job.
    
    triggerCiId - the UcmdbId of the CI.
    
    timeout - in milliseconds.
    
    Returns:
    
    the data on the execution of the job against the CI.
    
    Throws:
    
    TimeoutException
  - reRun
```
void reRun(DiscoveryContext context)
```
    Sets all tasks associated with the specified context to be re-executed.
    
    Parameters:
    
    context - the scope.
  - abortRun
```
void abortRun(DiscoveryContext context)
```
    Stops execution of all tasks associated with the specified context.
    
    Parameters:
    
    context - the scope.
  - getDiscoveryFactory
```
DiscoveryFactory getDiscoveryFactory()
```
    Returns the factory that creates the objects required by this service.
    
    Returns:
    
    the factory that creates the objects required by this service.
  - getContextFactory
```
ContextFactory getContextFactory()
```
    Returns the factory that creates DiscoveryContext objects.
    
    Returns:
    
    the factory that creates DiscoveryContext objects.
  - activateJobs
```
@Deprecated
void activateJobs(HashSet<String> jobs)
```
    Deprecated. as of UD 10.20, replaced by activate(com.hp.ucmdb.api.discovery.types.DiscoveryContext)
    
    Activates the jobs in the collection.
    
    Parameters:
    
    jobs - Collection of IDs of the jobs to activate.
  - deactivateJobs
```
@Deprecated
void deactivateJobs(HashSet<String> jobs)
```
    Deprecated. as of UD 10.20, replaced by deactivate(com.hp.ucmdb.api.discovery.types.DiscoveryContext)
    
    Deactivate the jobs in the collection.
    
    Parameters:
    
    jobs - Collection of IDs of the jobs to deactivate.
  - activate
```
void activate(DiscoveryContext context)
```
    Activates the jobs (discovery, population or activity) defined by the discovery context.
    
    Parameters:
    
    context - the discovery context. Specific CIs in the context are ignored.
  - deactivate
```
void deactivate(DiscoveryContext context)
```
    Deactivates the discovery, population, or activity jobs that are defined by the discovery context.
    
    Parameters:
    
    context - the discovery context. Specific CIs in the context are ignored.
  - pause
```
void pause(DiscoveryContext context)
```
    Pauses the jobs defined by the discovery context. Supported by service discovery context only
    
    Parameters:
    
    context -
  - resume
```
void resume(DiscoveryContext context)
```
    Resumes the jobs defined by the discovery context Supported by service discovery context only
    
    Parameters:
    
    context -
  - clearProbeResultsCacheByDiscoveryContext
```
void clearProbeResultsCacheByDiscoveryContext(DiscoveryContext context)
```
    Clears probe results data for collection of jobs defined by the discovery context Doesn't clear last successful invocation
    
    Parameters:
    
    context -
  - getDiscoveryProgressDashBoard
```
DiscoveryProgressData getDiscoveryProgressDashBoard(String... cis)
```
    get discovery progress widget data
    
    Parameters:
    
    cis -
    
    Returns:
    
    DiscoveryProgressData

Interface DDMManagementService

Method Summary

Method Detail

getProgress

getProgress

getErrors

getCredentialError

getErrors

getErrors

getErrors

getCIsErrorData

getDiagnosticInfo

getDiagnosticInfo

reRun

abortRun

getDiscoveryFactory

getContextFactory

activateJobs

deactivateJobs

activate

deactivate

pause

resume

clearProbeResultsCacheByDiscoveryContext

getDiscoveryProgressDashBoard