Interface UADHierarchyDeclaration
public interface UADHierarchyDeclaration
Declares a hierarchical relationship between multiple UAD displays.
-
Method Summary
Modifier and TypeMethodDescriptionUADDisplay<?>[]
Returns an array of UAD displays that correspond to a container type.getEntitiesTypeLabel
(Locale locale) Returns the translated label describing the entity types of the hierarchy.default String[]
Returns an array of field names to be rendered as columns in the UAD portlet's hierarchy view.UADDisplay<?>[]
Returns an array of UAD displays that correspond to a non-container type.
-
Method Details
-
getContainerUADDisplays
UADDisplay<?>[] getContainerUADDisplays()Returns an array of UAD displays that correspond to a container type. Order is significant here. The first item should represent the top-most type in the hierarchy, and each subsequent item should step down the hierarchy. The items retrieved using these UAD displays are shown before the items retrieved using the UAD displays fromgetNoncontainerUADDisplays()
. Often, an array of just one item is sufficient (in the case of folders and files, only a UAD display correlating to the folder type is returned).- Returns:
- an array of UAD displays that correspond to a container type
-
getEntitiesTypeLabel
Returns the translated label describing the entity types of the hierarchy.- Parameters:
locale
- the current locale- Returns:
- the label describing the entity types of the hierarchy
-
getExtraColumnNames
Returns an array of field names to be rendered as columns in the UAD portlet's hierarchy view. The corresponding data for each field name should be retrievable inside theUADDisplay#getFieldValues(Object, String[])
method of each UAD display returned fromgetContainerUADDisplays()
andgetNoncontainerUADDisplays()
.- Returns:
- an array of field names to be rendered as columns in the UAD portlet's hierarchy view
-
getNoncontainerUADDisplays
UADDisplay<?>[] getNoncontainerUADDisplays()Returns an array of UAD displays that correspond to a non-container type. The item types retrieved from these UAD displays are displayed in the same order as the array, and after the item types retrieved fromgetContainerUADDisplays()
. For example, in a folder and file structure, this returns the UAD display related to files.- Returns:
- an array of UAD displays that correspond to a non-container type
-