PluginUpdateCheckResult (formcycle: bom 8.0.4-RC.1 API)

java.lang.Object
- de.xima.fc.mdl.plugin.PluginUpdateCheckResult

All Implemented Interfaces:

Serializable
```
public class PluginUpdateCheckResult
extends Object
implements Serializable
```
POJO with the result of an attempt to check for updates of a plugin.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PluginUpdateCheckResult`	`empty(WorkspaceScope scope)`
`WorkspaceScope`	`getCheckedScopeWithUpdates()`
`int`	`getNumberOfAvailableUpdates()`
`Map<String,String>`	`getUpdatePluginMetaData()`
`static PluginUpdateCheckResult`	`updateCheckResult(int numberOfAvailableUpdates, WorkspaceScope checkedScopeWithUpdates, Map<String,String> updatePluginMetaData)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getNumberOfAvailableUpdates
```
public int getNumberOfAvailableUpdates()
```
    Returns:
    
    number of updates for a given scope.
  - getCheckedScopeWithUpdates
```
public WorkspaceScope getCheckedScopeWithUpdates()
```
    Returns:
    
    scope with possible updates for plugins.
  - empty
```
public static PluginUpdateCheckResult empty(WorkspaceScope scope)
```
    Parameters:
    
    scope - Workspace scope that was checked.
    
    Returns:
    
    New empty check results with the given scope and zero updates available.
  - updateCheckResult
```
public static PluginUpdateCheckResult updateCheckResult(int numberOfAvailableUpdates,
                                                        WorkspaceScope checkedScopeWithUpdates,
                                                        Map<String,String> updatePluginMetaData)
```
    Parameters:
    
    numberOfAvailableUpdates - number of updates in given scope
    
    checkedScopeWithUpdates - checked scope with updates
    
    updatePluginMetaData - Map between the name of the plugin and the available update version.
    
    Returns:
    
    the check result with the given parameters
  - getUpdatePluginMetaData
```
public Map<String,String> getUpdatePluginMetaData()
```
    Returns:
    
    a map of meta data with the plugin name from proma as key and the update version as the value.