IUiClass

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

IBaseClass

All Known Subinterfaces:

IAccount, IGroup, INamespace, INamespaceAuthenticationProvider, INamespaceAuthenticationProvider2, INamespaceAuthenticationProviderBase, INamespaceFolder, INamespaceTrustedSignonProvider, IRole
```
public interface IUiClass
extends IBaseClass
```
Defines the common interface for IBM Cognos user interface objects.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.Locale[]`	`getAvailableDescriptionLocales()` Returns all the locales for which a description of this object exists.
`java.lang.String`	`getDescription(java.util.Locale theLocale)` Returns the description of of this object for the specified locale.

Methods inherited from interface com.cognos.CAM_AAA.authentication.IBaseClass
getAncestors, getAvailableNameLocales, getHasChildren, getName, getObjectID

- Method Detail
  - getDescription
```
java.lang.String getDescription(java.util.Locale theLocale)
```
    Returns the description of of this object for the specified locale. Returns null if there is no description of this object for the locale specified.
    
    Parameters:
    
    theLocale - The locale that determines the language in which the description is returned.
    
    Returns:
    
    The description of this object in the language determined by the specified locale.
  - getAvailableDescriptionLocales
```
java.util.Locale[] getAvailableDescriptionLocales()
```
    Returns all the locales for which a description of this object exists.
    
    Returns:
    
    An array of locales for which a description exists.