DomainDriver.UserFilterManager (Silverpeas Core 6.3 API)

All Known Implementing Classes:

GoogleUserFilterManager

Enclosing interface:

DomainDriver
```
public static interface DomainDriver.UserFilterManager
```
Definition of a user filter manager.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getRule()`	Gets the current rule.
`String`	`getRuleKey()`	Gets the rule key.
`User[]`	`saveRule(String rule)`	Validates the given rule by performing a request of all users on external repository and save it on Silverpeas's domain repository.
`User[]`	`validateRule(String rule)`	Validates the given rule by performing a request of all users on external repository.

- Method Detail
  - getRuleKey
```
String getRuleKey()
```
    Gets the rule key.
    
    Returns:
    
    a string.
  - getRule
```
String getRule()
```
    Gets the current rule.
    
    Returns:
    
    a string.
  - validateRule
```
User[] validateRule(String rule)
             throws AdminException
```
    Validates the given rule by performing a request of all users on external repository.
    In case of success, the filtered users are returned.
    
    Parameters:
    
    rule - the rule to validate.
    
    Returns:
    
    an array of User.
    
    Throws:
    
    AdminException - in case of validation error.
  - saveRule
```
User[] saveRule(String rule)
         throws AdminException
```
    Validates the given rule by performing a request of all users on external repository and save it on Silverpeas's domain repository.
    In case of success, the filtered users of validation processing are returned.
    
    Parameters:
    
    rule - the rule to validate.
    
    Returns:
    
    an array of User.
    
    Throws:
    
    AdminException - in case of validation error.