Role (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.prefs.BaseManager
- - com.canto.cumulus.usermanagement.Role

```
public class Role
extends BaseManager
```
Instances of this class represent a single role. You can create a role by calling AuthenticationManager.getRole(String), AuthenticationManager.createRole(String) or AuthenticationManager.duplicateRole(String, String).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Role.CatalogNames
Manages the catalogs assigned to this role.

class Role.UserNames
Manages the users assigned to this role.
- Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager
  BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Nested Classes
Modifier and Type	Class and Description
`class`	`Role.CatalogNames` Manages the catalogs assigned to this role.
`class`	`Role.UserNames` Manages the users assigned to this role.

Field Summary
- Fields inherited from class com.canto.cumulus.prefs.BaseManager
  TYPE_EJP, TYPE_NATIVE

Method Summary

Methods
Modifier and Type	Method and Description
`EntityRestrictor`	`getAssetActions()` Returns the manager for Asset Action permissions for this role.
`EntityRestrictor`	`getAssetHandlingSets()` Returns the manager for Asset Handling Set permissions for this role.
`Role.CatalogNames`	`getCatalogNames()` Returns the manager of catalog names that are part of this role.
`EntityRestrictor`	`getCatalogTemplates()` Returns the manager for Catalog Templates permissions for this role.
`EntityRestrictor`	`getCategoryQueries()` Returns the manager for Category Query permissions for this role.
`EntityRestrictor`	`getCategoryViewSets()` Returns the manager for Category View Set permissions for this role.
`EntityRestrictor`	`getCollections()` Returns the manager for Collection permissions for this role.
`EntityRestrictor`	`getCropTemplates()` Returns the manager for Crop Templates permissions for this role.
`int`	`getDepartmentID()` Returns the ID of the department of this user.
`EntityRestrictor`	`getFilesystemCompanionInstances()` Returns the manager for filesystem companion instances permissions for this role.
`LiveFiltering`	`getLiveFiltering()` Returns the live filtering settings for this role.
`EntityRestrictor`	`getMetadataTemplates()` Returns the manager for Metadata Template permissions for this role.
`java.lang.String`	`getName()` Returns the name of this role.
`EntityRestrictor`	`getPermissionTemplates()` Returns the manager for Permission Template permissions for this role.
`EntityRestrictor`	`getPrintSets()` Returns the manager for Print Set permissions for this role.
`EntityRestrictor`	`getRecordFilters()` Returns the manager for Record Filter permissions for this role.
`EntityRestrictor`	`getRecordQueries()` Returns the manager for Record Query permissions for this role.
`EntityRestrictor`	`getRecordViewSets()` Returns the manager for Record View Set permissions for this role.
`EntityRestrictor`	`getReportSets()` Returns the manager for Report Set permissions for this role.
`RolePermissions`	`getRolePermissions()` Returns the permissions for this role.
`EntityRestrictor`	`getSchedulerJobs()` Returns the manager for Scheduler Job permissions for this role.
`ServerPermissions`	`getServerPermissions()` Returns the server permissions for this role.
`Role.UserNames`	`getUserNames()` Returns the manager for the users assigned to this role.
`void`	`save()` Save this role.
`void`	`setDepartmentID(int id)` Configures the ID of the department of this user.

Methods inherited from class com.canto.cumulus.prefs.BaseManager
addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, toString, writeAsXML

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

- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name of this role.
    
    Returns:
    name of role
  - getDepartmentID
```
public int getDepartmentID()
```
    Returns the ID of the department of this user.
    
    Returns:
    ID of the department of this user
    Since:
    
    8.5
  - setDepartmentID
```
public void setDepartmentID(int id)
```
    Configures the ID of the department of this user.
    
    Parameters:
    id - ID of the department of this user
    Since:
    
    8.5
  - getCatalogNames
```
public Role.CatalogNames getCatalogNames()
```
    Returns the manager of catalog names that are part of this role.
    
    Returns:
    manager of catalog names
  - getServerPermissions
```
public ServerPermissions getServerPermissions()
```
    Returns the server permissions for this role.
    
    Returns:
    server permissions for this role
  - getRolePermissions
```
public RolePermissions getRolePermissions()
```
    Returns the permissions for this role.
    
    Returns:
    permissions for this role
  - getLiveFiltering
```
public LiveFiltering getLiveFiltering()
```
    Returns the live filtering settings for this role.
    
    Returns:
    filtering settings
  - getUserNames
```
public Role.UserNames getUserNames()
```
    Returns the manager for the users assigned to this role.
    
    Returns:
    manager for the users assigned to this role
  - getAssetHandlingSets
```
public EntityRestrictor getAssetHandlingSets()
```
    Returns the manager for Asset Handling Set permissions for this role.
    
    Returns:
    manager for Asset Handling Sets for this role
  - getRecordViewSets
```
public EntityRestrictor getRecordViewSets()
```
    Returns the manager for Record View Set permissions for this role.
    
    Returns:
    manager for Record View Set permissions for this role
  - getCategoryViewSets
```
public EntityRestrictor getCategoryViewSets()
```
    Returns the manager for Category View Set permissions for this role.
    
    Returns:
    manager for Category View Set permissions for this role
  - getAssetActions
```
public EntityRestrictor getAssetActions()
```
    Returns the manager for Asset Action permissions for this role.
    
    Returns:
    manager for Asset Action permissions for this role
  - getMetadataTemplates
```
public EntityRestrictor getMetadataTemplates()
```
    Returns the manager for Metadata Template permissions for this role.
    
    Returns:
    manager for Metadata Template permissions for this role
  - getPermissionTemplates
```
public EntityRestrictor getPermissionTemplates()
```
    Returns the manager for Permission Template permissions for this role.
    
    Returns:
    manager for Permission Template permissions for this role
  - getRecordQueries
```
public EntityRestrictor getRecordQueries()
```
    Returns the manager for Record Query permissions for this role.
    
    Returns:
    manager for Record Query permissions for this role
  - getPrintSets
```
public EntityRestrictor getPrintSets()
```
    Returns the manager for Print Set permissions for this role.
    
    Returns:
    manager for Print Set permissions for this role
  - getCropTemplates
```
public EntityRestrictor getCropTemplates()
```
    Returns the manager for Crop Templates permissions for this role.
    
    Returns:
    manager for crop template permissions for this role
  - getRecordFilters
```
public EntityRestrictor getRecordFilters()
```
    Returns the manager for Record Filter permissions for this role.
    
    Returns:
    manager for Record Filter permissions for this role
  - getCatalogTemplates
```
public EntityRestrictor getCatalogTemplates()
```
    Returns the manager for Catalog Templates permissions for this role.
    
    Returns:
    manager for Catalog Templates permissions for this role
  - getCategoryQueries
```
public EntityRestrictor getCategoryQueries()
```
    Returns the manager for Category Query permissions for this role.
    
    Returns:
    manager for Category Query permissions for this role
  - getCollections
```
public EntityRestrictor getCollections()
```
    Returns the manager for Collection permissions for this role.
    
    Returns:
    manager for Collection permissions for this role
  - getSchedulerJobs
```
public EntityRestrictor getSchedulerJobs()
```
    Returns the manager for Scheduler Job permissions for this role.
    
    Returns:
    manager for Scheduler Job permissions for this role
  - getReportSets
```
public EntityRestrictor getReportSets()
```
    Returns the manager for Report Set permissions for this role.
    
    Returns:
    manager for Report Set permissions for this role
  - getFilesystemCompanionInstances
```
public EntityRestrictor getFilesystemCompanionInstances()
```
    Returns the manager for filesystem companion instances permissions for this role.
    
    Returns:
    manager for filesystem companion instances permissions for this role
    Since:
    
    8.6
  - save
```
public void save()
```
    Save this role.
    
    Overrides:
    
    save in class BaseManager

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class Role

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

Method Summary

Methods inherited from class com.canto.cumulus.prefs.BaseManager

Methods inherited from class java.lang.Object

Method Detail

getName

getDepartmentID

setDepartmentID

getCatalogNames

getServerPermissions

getRolePermissions

getLiveFiltering

getUserNames

getAssetHandlingSets

getRecordViewSets

getCategoryViewSets

getAssetActions

getMetadataTemplates

getPermissionTemplates

getRecordQueries

getPrintSets

getCropTemplates

getRecordFilters

getCatalogTemplates

getCategoryQueries

getCollections

getSchedulerJobs

getReportSets

getFilesystemCompanionInstances

save