TargetPlatformService (Nuxeo Target Platforms

```
public interface TargetPlatformService
```
Service for target platforms and packages management.

Since:

5.7.1

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`deprecateTargetPlatform(boolean deprecate, String id)` Deprecates the target platform if given boolean is true (or un-deprecates it if boolean is false), overriding the default value from extension points and adding an entry in the override directory.
`void`	`enableTargetPlatform(boolean enable, String id)` Enables the target platform if given boolean is true (or disables it boolean is false), overriding the default value from extension points and adding an entry in the override directory.
`List<TargetPlatform>`	`getAvailableTargetPlatforms(TargetPlatformFilter filter)` Returns all target platforms matching given criteria.
`List<TargetPlatformInfo>`	`getAvailableTargetPlatformsInfo(TargetPlatformFilter filter)` Returns all target platforms info matching given criteria.
`TargetPlatform`	`getDefaultTargetPlatform(TargetPlatformFilter filter)` Returns the default target platform.
`TargetPlatformInstance`	`getDefaultTargetPlatformInstance(boolean restricted)`
`String`	`getOverrideDirectory()` Returns the override directory name.
`TargetPackage`	`getTargetPackage(String id)` Returns the target package with given id, or null if not found.
`TargetPackageInfo`	`getTargetPackageInfo(String id)` Returns the target package info for given id, or null if not found.
`TargetPlatform`	`getTargetPlatform(String id)` Returns the target platform with given id, or null if not found.
`TargetPlatformInfo`	`getTargetPlatformInfo(String id)` Returns the target platform info for given id, or null if not found.
`TargetPlatformInstance`	`getTargetPlatformInstance(String id, List<String> packages)` Returns a target platform instance with given id and given enabled packages, or null if not found.
`void`	`restoreAllTargetPlatforms()` Removes overrides for all target platform.
`void`	`restoreTargetPlatform(String id)` Removes overrides for this target platform.
`void`	`restrictTargetPlatform(boolean restrict, String id)` Restricts the target platform if given boolean is true (or un-restricts it if boolean is false), overriding the default value from extension points and adding an entry in the override directory.
`void`	`setDefaultTargetPlatform(boolean isDefault, String id)` Set the target platform as default if given boolean is true (or unset it as default if boolean is false), overriding the default value from extension points and adding an entry in the override directory.
`void`	`setTrialTargetPlatform(boolean trial, String id)` Set the target platform as trial if given boolean is true (or unset it as trial if boolean is false), overriding the default value from extension points and adding an entry in the override directory.

- Method Detail
  - getOverrideDirectory
```
String getOverrideDirectory()
```
    Returns the override directory name.
  - getDefaultTargetPlatform
```
TargetPlatform getDefaultTargetPlatform(TargetPlatformFilter filter)
                                 throws ClientException
```
    Returns the default target platform.
    If several target platforms are found for given filter, the first one is returned (ordered alphabetically on id).
    
    Throws:
    
    ClientException
  - getTargetPlatform
```
TargetPlatform getTargetPlatform(String id)
                          throws ClientException
```
    Returns the target platform with given id, or null if not found.
    
    Throws:
    
    ClientException
  - getTargetPlatformInfo
```
TargetPlatformInfo getTargetPlatformInfo(String id)
                                  throws ClientException
```
    Returns the target platform info for given id, or null if not found.
    
    Throws:
    
    ClientException
  - getTargetPackage
```
TargetPackage getTargetPackage(String id)
```
    Returns the target package with given id, or null if not found.
  - getTargetPackageInfo
```
TargetPackageInfo getTargetPackageInfo(String id)
```
    Returns the target package info for given id, or null if not found.
  - getTargetPlatformInstance
```
TargetPlatformInstance getTargetPlatformInstance(String id,
                                                 List<String> packages)
                                          throws ClientException
```
    Returns a target platform instance with given id and given enabled packages, or null if not found.
    Ignore target packages that would not be found.
    
    Throws:
    
    ClientException
  - getAvailableTargetPlatforms
```
List<TargetPlatform> getAvailableTargetPlatforms(TargetPlatformFilter filter)
                                          throws ClientException
```
    Returns all target platforms matching given criteria.
    
    Parameters:
    
    filter - the filter to apply, can be null if no filtering is needed.
    
    Throws:
    
    ClientException
    
    See Also:
    
    TargetPlatformFilter
  - getAvailableTargetPlatformsInfo
```
List<TargetPlatformInfo> getAvailableTargetPlatformsInfo(TargetPlatformFilter filter)
                                                  throws ClientException
```
    Returns all target platforms info matching given criteria.
    
    Parameters:
    
    filter - the filter to apply, can be null if no filtering is needed.
    
    Throws:
    
    ClientException
    
    See Also:
    
    TargetPlatformFilter
  - deprecateTargetPlatform
```
void deprecateTargetPlatform(boolean deprecate,
                             String id)
                      throws ClientException
```
    Deprecates the target platform if given boolean is true (or un-deprecates it if boolean is false), overriding the default value from extension points and adding an entry in the override directory.
    
    Throws:
    
    ClientException
  - enableTargetPlatform
```
void enableTargetPlatform(boolean enable,
                          String id)
                   throws ClientException
```
    Enables the target platform if given boolean is true (or disables it boolean is false), overriding the default value from extension points and adding an entry in the override directory.
    
    Throws:
    
    ClientException
  - restrictTargetPlatform
```
void restrictTargetPlatform(boolean restrict,
                            String id)
                     throws ClientException
```
    Restricts the target platform if given boolean is true (or un-restricts it if boolean is false), overriding the default value from extension points and adding an entry in the override directory.
    
    Throws:
    
    ClientException
  - setTrialTargetPlatform
```
void setTrialTargetPlatform(boolean trial,
                            String id)
                     throws ClientException
```
    Set the target platform as trial if given boolean is true (or unset it as trial if boolean is false), overriding the default value from extension points and adding an entry in the override directory.
    
    Throws:
    
    ClientException
  - setDefaultTargetPlatform
```
void setDefaultTargetPlatform(boolean isDefault,
                              String id)
                       throws ClientException
```
    Set the target platform as default if given boolean is true (or unset it as default if boolean is false), overriding the default value from extension points and adding an entry in the override directory.
    
    Throws:
    
    ClientException
  - restoreTargetPlatform
```
void restoreTargetPlatform(String id)
                    throws ClientException
```
    Removes overrides for this target platform.
    
    Throws:
    
    ClientException
  - restoreAllTargetPlatforms
```
void restoreAllTargetPlatforms()
                        throws ClientException
```
    Removes overrides for all target platform.
    
    Throws:
    
    ClientException
  - getDefaultTargetPlatformInstance
```
TargetPlatformInstance getDefaultTargetPlatformInstance(boolean restricted)
                                                 throws ClientException
```
    Returns:
    
    the default target platform instance and enabled if not found.
    
    Throws:
    
    ClientException
    
    Since:
    
    5.9.3-NXP-15602

Interface TargetPlatformService

Method Summary

Method Detail

getOverrideDirectory

getDefaultTargetPlatform

getTargetPlatform

getTargetPlatformInfo

getTargetPackage

getTargetPackageInfo

getTargetPlatformInstance

getAvailableTargetPlatforms

getAvailableTargetPlatformsInfo

deprecateTargetPlatform

enableTargetPlatform

restrictTargetPlatform

setTrialTargetPlatform

setDefaultTargetPlatform

restoreTargetPlatform

restoreAllTargetPlatforms

getDefaultTargetPlatformInstance