PrincipalTypeService (Cyclos 4.16.20 Scripting API Documentation)

All Superinterfaces:

CRUDService<PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>, Service

All Known Subinterfaces:

PrincipalTypeServiceLocal
```
public interface PrincipalTypeService
extends CRUDService<PrincipalTypeDTO,PrincipalTypeData,PrincipalTypeNature>
```
Service interface for principal types. Principal types can be:
- Built-in: The ones defined in ExistingBuiltInPrincipalType
- Custom field: Using an unique custom field as principal
- Token: Using a token (card, NFC tag, etc) as principal
Principals are used to identify users. Together with a credential, which is used to authenticate the user, users can access channels in Cyclos.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`List<PrincipalTypeVO>`	`list()`	List all available principal types
`List<TokenPermissionsVO>`	`listUserTokenPermissions(UserLocatorVO user)`	Returns the permissions over tokens for the given user.

Methods inherited from interface org.cyclos.services.CRUDService
getData, getDataForNew, load, remove, removeAll, save

- Method Detail
  - list
```
List<PrincipalTypeVO> list()
                    throws FrameworkException
```
    List all available principal types
    
    Throws:
    
    FrameworkException
  - listUserTokenPermissions
```
List<TokenPermissionsVO> listUserTokenPermissions(UserLocatorVO user)
                                           throws FrameworkException
```
    Returns the permissions over tokens for the given user. If the user is null, returns permissions over other managed users.
    
    Throws:
    
    FrameworkException