UserContext (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.usermanagement.PredefinedPermissions
- - com.canto.cumulus.UserContext

```
public final class UserContext
extends PredefinedPermissions
```
The UserContext object represents the current logged-in user. It contains information about the user (user name, login name, etc) as well as the permissions this user has. All users have some predefined fields which value is not necessarily set, but one can also add new custom fields to any user.

Since:

1.0

See Also:
PredefinedPermissions, UserContextPredefinedFields

Field Summary

Fields
Modifier and Type	Field and Description
`static GUID`	`FID_STREET` The field ID of the user's mail address street name.
`static int`	`PASSWORD_OPTIONS_CANNOT_CHANGE_PASSWORD` Password setting value.
`static int`	`PASSWORD_OPTIONS_MUST_CHANGE_PASSWORD_WITH_NEXT_LOGIN` Password setting value.
`static int`	`PASSWORD_OPTIONS_PASSWORD_NEVER_EXPIRES` Password setting value.

Fields inherited from class com.canto.cumulus.usermanagement.PredefinedPermissions
PERMISSION_ASSET_COLLECT, PERMISSION_ASSET_DELETE, PERMISSION_ASSET_DOWNLOAD, PERMISSION_ASSET_EMAIL, PERMISSION_ASSET_SHOW_ORIGINAL, PERMISSION_ASSET_TRANSFER, PERMISSION_ASSET_VERSIONING, PERMISSION_CAN_ACCESS_ALL_ASSET_ACTIONS, PERMISSION_CAN_ACCESS_ALL_ASSET_HANDLING_SETS, PERMISSION_CAN_ACCESS_ALL_CATEGORY_QUERIES, PERMISSION_CAN_ACCESS_ALL_CATEGORY_VIEW_SETS, PERMISSION_CAN_ACCESS_ALL_CROP_TEMPLATES, PERMISSION_CAN_ACCESS_ALL_METADATA_TEMPLATES, PERMISSION_CAN_ACCESS_ALL_PERMISSION_TEMPLATES, PERMISSION_CAN_ACCESS_ALL_PRINT_SETS, PERMISSION_CAN_ACCESS_ALL_RECORD_FILTERS, PERMISSION_CAN_ACCESS_ALL_RECORD_QUERIES, PERMISSION_CAN_ACCESS_ALL_RECORD_VIEW_SETS, PERMISSION_CATALOG_AUTO_TAGGING_USER, PERMISSION_CATALOG_LOG_ADMIN, PERMISSION_CATALOG_MANAGE_CATALOG_MIRRORING, PERMISSION_CATALOG_MANAGE_CENTRAL_ASSET_LOCATION, PERMISSION_CATALOG_MANAGE_TRIGGERS, PERMISSION_CATALOG_MODIFY_CATALOG_CATEGORY_PERMISSIONS, PERMISSION_CATALOG_MODIFY_SETTINGS, PERMISSION_CATALOG_MONITOR_ADMIN, PERMISSION_CATALOG_OPEN, PERMISSION_CATALOG_TRIGGER_ADMIN, PERMISSION_CATALOG_VIDEO_CLOUD_ADMIN, PERMISSION_CATALOG_VIDEO_CLOUD_CONSUMER, PERMISSION_CATALOG_VIDEO_CLOUD_CONTRIBUTOR, PERMISSION_CATALOG_VIEW_SETTINGS, PERMISSION_ITEM_CREATE, PERMISSION_ITEM_DELETE, PERMISSION_ITEM_MODIFY, PERMISSION_ITEM_MODIFY_ASSET_REFERENCE, PERMISSION_ITEM_MODIFY_PERMISSIONS, PERMISSION_ITEM_MODIFY_TRIGGERS, PERMISSION_ITEM_VIEW, PERMISSION_MEDIA_DELIVERY_CLOUD_ADMIN, SERVER_PERMISSION_BACKUP_ADMIN, SERVER_PERMISSION_BROWSE_EXTERNAL_USERS, SERVER_PERMISSION_BROWSE_USERS, SERVER_PERMISSION_CAN_ACCESS_ALL_CATALOG_TEMPLATES, SERVER_PERMISSION_CAN_ACCESS_ALL_CATALOGS, SERVER_PERMISSION_CAN_ACCESS_ALL_COLLECTIONS, SERVER_PERMISSION_CAN_ACCESS_ALL_FILESYSTEM_COMPANION_INSTANCES, SERVER_PERMISSION_CAN_ACCESS_ALL_REPORT_SETS, SERVER_PERMISSION_CAN_ACCESS_ALL_SCHEDULER_JOBS, SERVER_PERMISSION_CREATE_DOWNLOAD_COLLECTION, SERVER_PERMISSION_CREATE_EXTERNAL_USERS, SERVER_PERMISSION_CREATE_SHARED_ASSET_ACTION, SERVER_PERMISSION_CREATE_SHARED_ASSETHANDLING_SET, SERVER_PERMISSION_CREATE_SHARED_CATALOG_TEMPLATE, SERVER_PERMISSION_CREATE_SHARED_CATEGORY_QUERY, SERVER_PERMISSION_CREATE_SHARED_CATEGORYVIEW_SET, SERVER_PERMISSION_CREATE_SHARED_COLLECTION, SERVER_PERMISSION_CREATE_SHARED_CROP_TEMPLATES, SERVER_PERMISSION_CREATE_SHARED_FILESYSTEM_COMPANION_INSTANCE, SERVER_PERMISSION_CREATE_SHARED_METADATA_TEMPLATE, SERVER_PERMISSION_CREATE_SHARED_PERMISSION_TEMPLATE, SERVER_PERMISSION_CREATE_SHARED_PRINT_SET, SERVER_PERMISSION_CREATE_SHARED_RECORD_FILTER, SERVER_PERMISSION_CREATE_SHARED_RECORD_QUERY, SERVER_PERMISSION_CREATE_SHARED_RECORDVIEW_SET, SERVER_PERMISSION_CREATE_SHARED_REPORT_SET, SERVER_PERMISSION_CREATE_SHARED_SCHEDULER_JOB, SERVER_PERMISSION_CREATE_UPLOAD_COLLECTION, SERVER_PERMISSION_DELETE_SHARED_ASSET_ACTION, SERVER_PERMISSION_DELETE_SHARED_ASSETHANDLING_SET, SERVER_PERMISSION_DELETE_SHARED_CATALOG_TEMPLATE, SERVER_PERMISSION_DELETE_SHARED_CATEGORY_QUERY, SERVER_PERMISSION_DELETE_SHARED_CATEGORYVIEW_SET, SERVER_PERMISSION_DELETE_SHARED_COLLECTION, SERVER_PERMISSION_DELETE_SHARED_CROP_TEMPLATES, SERVER_PERMISSION_DELETE_SHARED_FILESYSTEM_COMPANION_INSTANCE, SERVER_PERMISSION_DELETE_SHARED_METADATA_TEMPLATE, SERVER_PERMISSION_DELETE_SHARED_PERMISSION_TEMPLATE, SERVER_PERMISSION_DELETE_SHARED_PRINT_SET, SERVER_PERMISSION_DELETE_SHARED_RECORD_FILTER, SERVER_PERMISSION_DELETE_SHARED_RECORD_QUERY, SERVER_PERMISSION_DELETE_SHARED_RECORDVIEW_SET, SERVER_PERMISSION_DELETE_SHARED_REPORT_SET, SERVER_PERMISSION_DELETE_SHARED_SCHEDULER_JOB, SERVER_PERMISSION_FORCE_READ_ONLY_CATALOG_ACCESS, SERVER_PERMISSION_MAIL_ADMIN, SERVER_PERMISSION_MANAGE_USER_ASSET_ACTIONS, SERVER_PERMISSION_MANAGE_USER_ASSETHANDLING_SET, SERVER_PERMISSION_MANAGE_USER_CATALOG_TEMPLATES, SERVER_PERMISSION_MANAGE_USER_CATEGORY_QUERIES, SERVER_PERMISSION_MANAGE_USER_CATEGORYVIEW_SET, SERVER_PERMISSION_MANAGE_USER_COLLECTIONS, SERVER_PERMISSION_MANAGE_USER_CROP_TEMPLATES, SERVER_PERMISSION_MANAGE_USER_METADATA_TEMPLATES, SERVER_PERMISSION_MANAGE_USER_PERMISSION_TEMPLATES, SERVER_PERMISSION_MANAGE_USER_PRINT_SETS, SERVER_PERMISSION_MANAGE_USER_RECORD_FILTERS, SERVER_PERMISSION_MANAGE_USER_RECORD_QUERIES, SERVER_PERMISSION_MANAGE_USER_RECORDVIEW_SET, SERVER_PERMISSION_MEDIA_DELIVERY_CLOUD_ADMIN, SERVER_PERMISSION_MODIFY_SHARED_ASSET_ACTION, SERVER_PERMISSION_MODIFY_SHARED_ASSETHANDLING_SET, SERVER_PERMISSION_MODIFY_SHARED_CATALOG_TEMPLATE, SERVER_PERMISSION_MODIFY_SHARED_CATEGORY_QUERY, SERVER_PERMISSION_MODIFY_SHARED_CATEGORYVIEW_SET, SERVER_PERMISSION_MODIFY_SHARED_COLLECTION, SERVER_PERMISSION_MODIFY_SHARED_CROP_TEMPLATES, SERVER_PERMISSION_MODIFY_SHARED_FILESYSTEM_COMPANION_INSTANCE, SERVER_PERMISSION_MODIFY_SHARED_METADATA_TEMPLATE, SERVER_PERMISSION_MODIFY_SHARED_PERMISSION_TEMPLATE, SERVER_PERMISSION_MODIFY_SHARED_PRINT_SET, SERVER_PERMISSION_MODIFY_SHARED_RECORD_FILTER, SERVER_PERMISSION_MODIFY_SHARED_RECORD_QUERY, SERVER_PERMISSION_MODIFY_SHARED_RECORDVIEW_SET, SERVER_PERMISSION_MODIFY_SHARED_REPORT_SET, SERVER_PERMISSION_MODIFY_SHARED_SCHEDULER_JOB, SERVER_PERMISSION_MODIFY_USER_SETTINGS_ASSETHANDLING, SERVER_PERMISSION_MODIFY_USER_SETTINGS_DISPLAY, SERVER_PERMISSION_MODIFY_USER_SETTINGS_GENERAL, SERVER_PERMISSION_MODIFY_USER_SETTINGS_PRINT, SERVER_PERMISSION_MODIFY_USER_SETTINGS_SEARCH, SERVER_PERMISSION_REPLACE_USER_SETTINGS_PATH, SERVER_PERMISSION_ROBOFLOW_EXECUTE, SERVER_PERMISSION_ROBOFLOW_MANAGE, SERVER_PERMISSION_RUN_AS, SERVER_PERMISSION_RUN_AS_ALL_USERS, SERVER_PERMISSION_SET_DEFAULT_SHARED_ASSET_ACTION, SERVER_PERMISSION_SET_DEFAULT_SHARED_ASSETHANDLING_SET, SERVER_PERMISSION_SET_DEFAULT_SHARED_CATALOG_TEMPLATE, SERVER_PERMISSION_SET_DEFAULT_SHARED_CATEGORYVIEW_SET, SERVER_PERMISSION_SET_DEFAULT_SHARED_COLLECTION, SERVER_PERMISSION_SET_DEFAULT_SHARED_CROP_TEMPLATES, SERVER_PERMISSION_SET_DEFAULT_SHARED_FILESYSTEM_COMPANION_INSTANCE, SERVER_PERMISSION_SET_DEFAULT_SHARED_METADATA_TEMPLATE, SERVER_PERMISSION_SET_DEFAULT_SHARED_PERMISSION_TEMPLATE, SERVER_PERMISSION_SET_DEFAULT_SHARED_PRINT_SET, SERVER_PERMISSION_SET_DEFAULT_SHARED_RECORD_FILTER, SERVER_PERMISSION_SET_DEFAULT_SHARED_RECORDVIEW_SET, SERVER_PERMISSION_SET_DEFAULT_SHARED_REPORT_SET, SERVER_PERMISSION_SET_DEFAULT_SHARED_SCHEDULER_JOB, SERVER_PERMISSION_SITES_ADMIN, SERVER_PERMISSION_USE_EXTERNAL_USERS, SERVER_PERMISSION_USER_ADMIN, SERVER_PERMISSION_USER_ADMIN_DEPARTMENT_RO, SERVER_PERMISSION_USER_ADMIN_DEPARTMENT_RW, SERVER_PERMISSION_VAULT_ADMIN, SERVER_PERMISSION_VIEW_SHARED_ASSET_ACTION, SERVER_PERMISSION_VIEW_SHARED_ASSETHANDLING_SET, SERVER_PERMISSION_VIEW_SHARED_CATALOG_TEMPLATE, SERVER_PERMISSION_VIEW_SHARED_CATEGORY_QUERY, SERVER_PERMISSION_VIEW_SHARED_CATEGORYVIEW_SET, SERVER_PERMISSION_VIEW_SHARED_CROP_TEMPLATES, SERVER_PERMISSION_VIEW_SHARED_METADATA_TEMPLATE, SERVER_PERMISSION_VIEW_SHARED_PERMISSION_TEMPLATE, SERVER_PERMISSION_VIEW_SHARED_PRINT_SET, SERVER_PERMISSION_VIEW_SHARED_RECORD_FILTER, SERVER_PERMISSION_VIEW_SHARED_RECORD_QUERY, SERVER_PERMISSION_VIEW_SHARED_RECORDVIEW_SET, SERVER_PERMISSION_WORKFLOW_ADMIN, TOKEN_PERMISSION_SEPARATOR

Method Summary

Methods
Modifier and Type	Method and Description
`GUID`	`findFieldByName(java.lang.String fieldName)` Find a field by name and return it's `GUID`.
`java.util.Collection<java.lang.String>`	`getAssetActionNames(Catalog catalog)` Returns all Asset Action names available to this user for the given catalog.
`java.util.Collection<java.lang.String>`	`getAssetHandlingSetNames(Catalog catalog)` Returns all Asset Handling Set names available to this user for the given catalog.
`java.util.Collection<java.lang.String>`	`getCategoryQueryNames(Catalog catalog)` Returns all server-side category query names available to this user for the given catalog.
`java.util.Collection<java.lang.String>`	`getCategoryViewSetNames(Catalog catalog)` Returns all Category View Set names available to this user for the given catalog.
`java.util.Collection<java.lang.String>`	`getCropTemplateNames(Catalog catalog)` Returns all crop template names available to this user for the given catalog.
`CumulusSession`	`getCumulusSession()` Returns the current `CumulusSession` object.
`java.util.Collection<java.lang.String>`	`getCustomPermissions(Catalog catalog)` Returns all custom permissions assigned to this user for a specific catalog.
`java.util.Collection<java.lang.String>`	`getCustomServerPermissions()` Returns all custom server permissions assigned to this user.
`java.lang.String`	`getDisplayName()` Returns the display name for this user.
`java.lang.String`	`getDisplayOrLoginName()` Returns the display name for this user.
`java.lang.String`	`getEmailAddress()` Returns the email address as stored.
`java.lang.String`	`getEmailAddressRFC822()` Returns the email address formatted according to RFC822.
`java.lang.String`	`getFieldName(GUID fieldUID)` Returns the name of a field in the default language ID.
`java.lang.String`	`getFieldName(GUID fieldUID, int languageId)` Returns the name of a field.
`int`	`getFieldType(GUID fieldUID)` Returns the type of a user context field with the given `GUID`.
`java.util.Set<GUID>`	`getFieldUIDs()` Returns the available field UIDs.
`java.lang.Object`	`getFieldValue(GUID fieldUID)` Return the value of a user context field in the default language.
`java.lang.Object`	`getFieldValue(GUID fieldUID, int languageId)` Return the value of a user context field.
`java.lang.String`	`getLoginName()` Returns the logging name.
`java.util.Collection<java.lang.String>`	`getMetadataTemplateNames(Catalog catalog)` Returns all server-side metadata template names available to this user for the given catalog.
`java.util.Collection<java.lang.String>`	`getPermissions(Catalog catalog)` Returns all permissions assigned to this user for a specific catalog.
`java.util.Collection<java.lang.String>`	`getPermissionTemplateNames(Catalog catalog)` Returns all permission template names available to this user for the given catalog.
`java.util.Collection<java.lang.String>`	`getPrintSetNames(Catalog catalog)` Returns all print set names available to this user for the given catalog.
`java.util.Collection<java.lang.String>`	`getRecordFilterNames(Catalog catalog)` Returns all record filter names available to this user for the given catalog.
`java.util.Collection<java.lang.String>`	`getRecordQueryNames(Catalog catalog)` Returns all server-side record query names available to this user for the given catalog.
`java.util.Collection<java.lang.String>`	`getRecordViewSetNames(Catalog catalog)` Returns all Record View Set names available to this user for the given catalog.
`java.util.Set<java.lang.String>`	`getRoleUIDs()` Returns all role UIDs of the roles this user is a member of.
`java.util.Collection<java.lang.String>`	`getServerPermissions()` Returns all server permissions assigned to this user.
`java.lang.String`	`getUniqueUserID()` Returns the unique user uid for this user.
`boolean`	`hasPermission(java.lang.String permission, Catalog catalog)` Returns whether this user has the given permission in the specified catalog.
`boolean`	`hasPermission(java.lang.String permission, Catalog catalog, java.lang.String tableName)` Returns whether this user has the given permission in the specified sub-table in the specified catalog.
`boolean`	`hasPermission(java.lang.String permission, Item item)` Returns whether the current user has the specified permission on the given item either through the catalog permissions or by a permission being assigned to the item itself.
`boolean`	`hasPermission(java.lang.String permission, ItemCollection itemCollection)` Returns whether the current user has the specified permission on the given item collection.
`boolean`	`hasRecordLiveFilter(Catalog catalog)` Returns whether this user has a live filter applied for the specified catalog.
`boolean`	`hasServerPermission(java.lang.String permission)` Returns whether this user has the given server permission.
`boolean`	`isAdmin()` Returns whether this user is the Cumulus admin user.
`boolean`	`isGuest()` Returns whether the user is the guest user.

Methods inherited from class com.canto.cumulus.usermanagement.PredefinedPermissions
getAllPermissions, getAllServerPermissions

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

- Field Detail
  - FID_STREET
```
public static final GUID FID_STREET
```
    The field ID of the user's mail address street name.
  - PASSWORD_OPTIONS_MUST_CHANGE_PASSWORD_WITH_NEXT_LOGIN
```
public static final int PASSWORD_OPTIONS_MUST_CHANGE_PASSWORD_WITH_NEXT_LOGIN
```
    Password setting value. The user must change it's password with next login.
    
    See Also:
    Constant Field Values
  - PASSWORD_OPTIONS_CANNOT_CHANGE_PASSWORD
```
public static final int PASSWORD_OPTIONS_CANNOT_CHANGE_PASSWORD
```
    Password setting value. The user cannot change it's password.
    
    See Also:
    Constant Field Values
  - PASSWORD_OPTIONS_PASSWORD_NEVER_EXPIRES
```
public static final int PASSWORD_OPTIONS_PASSWORD_NEVER_EXPIRES
```
    Password setting value. The password never expires.
    
    See Also:
    Constant Field Values
- Method Detail
  - getCumulusSession
```
public CumulusSession getCumulusSession()
```
    Returns the current CumulusSession object.
    
    Returns:
    the current CumulusSession object.
  - getUniqueUserID
```
public java.lang.String getUniqueUserID()
```
    Returns the unique user uid for this user.
    
    Returns:
    unique user uid for this user
    Since:
    
    7.0
  - getRoleUIDs
```
public java.util.Set<java.lang.String> getRoleUIDs()
```
    Returns all role UIDs of the roles this user is a member of.
    
    Returns:
    role UIDs of the roles this user is a member of
  - getLoginName
```
public java.lang.String getLoginName()
```
    Returns the logging name.
    
    Returns:
    the logging name.
  - getDisplayOrLoginName
```
public java.lang.String getDisplayOrLoginName()
```
    Returns the display name for this user. The display name is made up of three parts
```
[FirstName] [Middle Name] [Last Name]
```
    . If no name part can be found, the login name is returned.
    Returns:
    the display name or login name
    Since:
    
    9.0
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Returns the display name for this user. The display name is made up of three parts
```
[FirstName] [Middle Name] [Last Name]
```
    . If no name part can be found, an empty String is returned.
    Returns:
    the display name or an empty non-null String
    Since:
    
    8.1.1
  - getEmailAddressRFC822
```
public java.lang.String getEmailAddressRFC822()
```
    Returns the email address formatted according to RFC822. Example: John President <john@canto.com>
    
    Returns:
    the email address according to RFC 822 or null
    Since:
    
    8.1.1
  - getEmailAddress
```
public java.lang.String getEmailAddress()
```
    Returns the email address as stored.
    
    Returns:
    the email address as stored or null
    Since:
    
    9.0
  - getFieldUIDs
```
public java.util.Set<GUID> getFieldUIDs()
```
    Returns the available field UIDs.
    
    Returns:
    available field UIDs
    Since:
    
    8.6
  - getFieldValue
```
public java.lang.Object getFieldValue(GUID fieldUID)
```
    Return the value of a user context field in the default language.
    
    Parameters:
    fieldUID - the field GUID.
    
    Returns:
    the value of a user context field.
  - getFieldValue
```
public java.lang.Object getFieldValue(GUID fieldUID,
                             int languageId)
```
    Return the value of a user context field.
    
    Parameters:
    fieldUID - the field GUID.
    languageId - the field language.
    
    Returns:
    the value of a user context field.
  - findFieldByName
```
public GUID findFieldByName(java.lang.String fieldName)
```
    Find a field by name and return it's GUID.
    
    Parameters:
    fieldName - the field name.
    
    Returns:
    the field GUID or null if the name doesn't match a field.
  - getFieldName
```
public java.lang.String getFieldName(GUID fieldUID)
```
    Returns the name of a field in the default language ID.
    
    Parameters:
    fieldUID - the field GUID.
    
    Returns:
    the name of a field.
  - getFieldName
```
public java.lang.String getFieldName(GUID fieldUID,
                            int languageId)
```
    Returns the name of a field.
    
    Parameters:
    fieldUID - the field GUID.
    languageId - the field language.
    
    Returns:
    the name of a field.
  - getFieldType
```
public int getFieldType(GUID fieldUID)
```
    Returns the type of a user context field with the given GUID.
    Parameters:
    fieldUID - the field GUID.
    
    Returns:
    the field type. Possible values are:
    
    FieldTypes.FieldTypeString
    
    FieldTypes.FieldTypeBool
    
    FieldTypes.FieldTypeInteger
    
    FieldTypes.FieldTypeDouble
    
    FieldTypes.FieldTypeDate
    
    FieldTypes.FieldTypeBinary
    
    FieldTypes.FieldTypePicture
    
    FieldTypes.FieldTypeEnum
    
    FieldTypes.FieldTypeAudio
    
    FieldTypes.FieldTypeLong
  - hasPermission
```
public boolean hasPermission(java.lang.String permission,
                    Catalog catalog)
```
    Returns whether this user has the given permission in the specified catalog. Only catalog-wide permissions should be checked using this method. For permissions that that grant access to asset, records, categories or other table-based items use hasPermission(String, Item).
    
    Parameters:
    permission - the permission to check. This is either a predefined permission or a custom string. You can get a list of all predefined permissions by calling PredefinedPermissions.getAllPermissions().
    catalog - the catalog to check the permission for.
    
    Returns:
    true if the user has the permission; false otherwise.
  - hasPermission
```
public boolean hasPermission(java.lang.String permission,
                    Item item)
```
    Returns whether the current user has the specified permission on the given item either through the catalog permissions or by a permission being assigned to the item itself.
    
    Parameters:
    permission - the permission to check. This is either a predefined permission or a custom string. You can get a list of all predefined permissions by calling PredefinedPermissions.getAllPermissions().
    item - the item to check the permission for
    
    Returns:
    true if the user has the permission on the item; false otherwise.
    Since:
    
    8.0
  - hasPermission
```
public boolean hasPermission(java.lang.String permission,
                    ItemCollection itemCollection)
```
    Returns whether the current user has the specified permission on the given item collection.
    
    Parameters:
    permission - the permission to check. This is either a predefined permission or a custom string. You can get a list of all predefined permissions by calling PredefinedPermissions.getAllPermissions().
    itemCollection - the item collection to check the permission for
    
    Returns:
    true if the user has the permission on the item collection; false otherwise.
    Since:
    
    8.0
  - hasPermission
```
public boolean hasPermission(java.lang.String permission,
                    Catalog catalog,
                    java.lang.String tableName)
```
    Returns whether this user has the given permission in the specified sub-table in the specified catalog. To check permissions granted to an individual item of a sub-table use hasPermission(String, Item).
    
    Parameters:
    permission - the permission to check. This is either a predefined permission or a custom string. You can get a list of all predefined permissions by calling PredefinedPermissions.getAllPermissions().
    catalog - the catalog to check the permission for.
    tableName - The name of the sub-table to check the permission for.
    
    Returns:
    true if the user has the permission; false otherwise.
    Since:
    
    11.1.3
  - hasServerPermission
```
public boolean hasServerPermission(java.lang.String permission)
```
    Returns whether this user has the given server permission.
    
    Parameters:
    permission - the server permission to check. This is either a predefined permission or a custom string. You can get a list of all predefined server permissions by calling PredefinedPermissions.getAllServerPermissions()
    
    Returns:
    true if the user has the server permission; false otherwise.
  - isGuest
```
public boolean isGuest()
```
    Returns whether the user is the guest user.
    
    Returns:
    true if the user is the guest user; false otherwise.
  - isAdmin
```
public boolean isAdmin()
```
    Returns whether this user is the Cumulus admin user.
    
    Returns:
    true if this is the Cumulus admin user, otherwise false
  - getPermissions
```
public java.util.Collection<java.lang.String> getPermissions(Catalog catalog)
```
    Returns all permissions assigned to this user for a specific catalog.
    
    Parameters:
    catalog - the catalog.
    
    Returns:
    a collection of strings of all permissions assigned to this user for a specific catalog.
    Since:
    
    7.0
  - getCustomPermissions
```
public java.util.Collection<java.lang.String> getCustomPermissions(Catalog catalog)
```
    Returns all custom permissions assigned to this user for a specific catalog. Custom permissions are identified by checking that their name does not start with the $ character.
    
    Parameters:
    catalog - the catalog.
    
    Returns:
    a collection of strings of all custom permissions assigned to this user for a specific catalog.
    Since:
    
    11.1.3
  - getServerPermissions
```
public java.util.Collection<java.lang.String> getServerPermissions()
```
    Returns all server permissions assigned to this user.
    
    Returns:
    a collection of strings of all server permissions assigned to this user.
    Since:
    
    7.0
  - getCustomServerPermissions
```
public java.util.Collection<java.lang.String> getCustomServerPermissions()
```
    Returns all custom server permissions assigned to this user.
    
    Returns:
    a collection of strings of all custom server permissions assigned to this user.
    Since:
    
    11.1.3
  - getRecordViewSetNames
```
public java.util.Collection<java.lang.String> getRecordViewSetNames(Catalog catalog)
```
    Returns all Record View Set names available to this user for the given catalog.
    
    Parameters:
    catalog - catalog
    
    Returns:
    a collection of strings of all record view set names.
    Since:
    
    7.0
  - getCategoryViewSetNames
```
public java.util.Collection<java.lang.String> getCategoryViewSetNames(Catalog catalog)
```
    Returns all Category View Set names available to this user for the given catalog.
    
    Parameters:
    catalog - catalog
    
    Returns:
    a collection of strings of all category view set names.
    Since:
    
    7.0
  - getAssetHandlingSetNames
```
public java.util.Collection<java.lang.String> getAssetHandlingSetNames(Catalog catalog)
```
    Returns all Asset Handling Set names available to this user for the given catalog.
    
    Parameters:
    catalog - catalog
    
    Returns:
    a collection of strings of all asset handling set names.
    Since:
    
    7.0
  - getAssetActionNames
```
public java.util.Collection<java.lang.String> getAssetActionNames(Catalog catalog)
```
    Returns all Asset Action names available to this user for the given catalog.
    
    Parameters:
    catalog - catalog
    
    Returns:
    a collection of strings of all asset action names.
    Since:
    
    7.0
  - getRecordQueryNames
```
public java.util.Collection<java.lang.String> getRecordQueryNames(Catalog catalog)
```
    Returns all server-side record query names available to this user for the given catalog.
    
    Parameters:
    catalog - catalog
    
    Returns:
    a collection of strings of all record query names.
    Since:
    
    7.0
  - getCategoryQueryNames
```
public java.util.Collection<java.lang.String> getCategoryQueryNames(Catalog catalog)
```
    Returns all server-side category query names available to this user for the given catalog.
    
    Parameters:
    catalog - catalog
    
    Returns:
    a collection of strings of all category query names.
    Since:
    
    7.0
  - getMetadataTemplateNames
```
public java.util.Collection<java.lang.String> getMetadataTemplateNames(Catalog catalog)
```
    Returns all server-side metadata template names available to this user for the given catalog.
    
    Parameters:
    catalog - catalog
    
    Returns:
    a collection of strings of all metadata template names.
    Since:
    
    7.0
  - getPrintSetNames
```
public java.util.Collection<java.lang.String> getPrintSetNames(Catalog catalog)
```
    Returns all print set names available to this user for the given catalog.
    
    Parameters:
    catalog - catalog
    
    Returns:
    a collection of strings of all print set names.
    Since:
    
    7.0
  - getCropTemplateNames
```
public java.util.Collection<java.lang.String> getCropTemplateNames(Catalog catalog)
```
    Returns all crop template names available to this user for the given catalog.
    
    Parameters:
    catalog - catalog
    
    Returns:
    a collection of strings of all crop template names.
    Since:
    
    11.0.2
  - getRecordFilterNames
```
public java.util.Collection<java.lang.String> getRecordFilterNames(Catalog catalog)
```
    Returns all record filter names available to this user for the given catalog.
    
    Parameters:
    catalog - catalog
    
    Returns:
    a collection of strings of all record filter names.
    Since:
    
    7.1
  - getPermissionTemplateNames
```
public java.util.Collection<java.lang.String> getPermissionTemplateNames(Catalog catalog)
```
    Returns all permission template names available to this user for the given catalog.
    
    Parameters:
    catalog - catalog
    
    Returns:
    a collection of strings of all permission template names.
    Since:
    
    7.0
  - hasRecordLiveFilter
```
public boolean hasRecordLiveFilter(Catalog catalog)
```
    Returns whether this user has a live filter applied for the specified catalog.
    
    Parameters:
    catalog - The catalog to check
    
    Returns:
    true if a live filter is applied when working with the specified catalog
    Since:
    
    7.5.1

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 UserContext

Field Summary

Fields inherited from class com.canto.cumulus.usermanagement.PredefinedPermissions

Method Summary

Methods inherited from class com.canto.cumulus.usermanagement.PredefinedPermissions

Methods inherited from class java.lang.Object

Field Detail

FID_STREET

PASSWORD_OPTIONS_MUST_CHANGE_PASSWORD_WITH_NEXT_LOGIN

PASSWORD_OPTIONS_CANNOT_CHANGE_PASSWORD

PASSWORD_OPTIONS_PASSWORD_NEVER_EXPIRES

Method Detail

getCumulusSession

getUniqueUserID

getRoleUIDs

getLoginName

getDisplayOrLoginName

getDisplayName

getEmailAddressRFC822

getEmailAddress

getFieldUIDs

getFieldValue

getFieldValue

findFieldByName

getFieldName

getFieldName

getFieldType

hasPermission

hasPermission

hasPermission

hasPermission

hasServerPermission

isGuest

isAdmin

getPermissions

getCustomPermissions

getServerPermissions

getCustomServerPermissions

getRecordViewSetNames

getCategoryViewSetNames

getAssetHandlingSetNames

getAssetActionNames

getRecordQueryNames

getCategoryQueryNames

getMetadataTemplateNames

getPrintSetNames

getCropTemplateNames

getRecordFilterNames

getPermissionTemplateNames

hasRecordLiveFilter