PageByUnit

Constant used by getSortType() to indicate the unit is sorted ascending.

Constant used by getSortType() to indicate the unit is using its default sort.

Constant used by getSortType() to indicate the unit is sorted descending.

Constant used by getSortType() to indicate the unit is not sorted.

This method returns the alias for this unit. The alias is the name of the unit displayed to the end user, typically the object of the underlying WebObjectInfo.

The alias might be different from the object's name, as end-users can change the alias in the working set.

Returns the enumeration of PageByElementList available for this unit. A PageByElementList represents the list of elements the user can select to filter the data. Although typically it only has one, a unit may have more PageByElementList objects.

When the bean is in design mode, the PageByElementLists are not available and this method will return an empty enumeration.

The key is used to uniquely identify the Page-by unit within the units collection. This key is used in events to indicate which unit is being manipulated.

This method is used to navigate across the collection of page-by units. It returns the next PageByUnit; if this is the last one, it returns null.

This method is used to navigate across the collection of page-by units. It returns the previous PageByUnit; if this is the first one, it returns null.

This method returns the key used by the rename dialog to identify this unit within the working set. This is only meaningful if the unit can be renamed.

Returns the current sort of this unit. This is only meaningful if the unit can be sorted. It returns one of the following values:

• SORT_EMPTY
• SORT_DEFAULT
• SORT_ASCENDING
• SORT_DESCENDING

This returns the WebObjectInfo associated with this unit (if any). In case the unit is the Metrics-axis, it will have no target associated.

returns the target component bean (Report Bean or RW Bean).

Returns the underlying title object associated with this unit. for documents it returns null;.

Returns the underlying WebApi object associated with this unit. For reports it returns an instance of a WebTemplateUnit; for documents it returns a RWGroupByUnit.

It returns the EnumDSSXMLTemplateUnitType associated with this unit. This is only meaningful in the case of reports as documents don't use WebTemplateUnits.

Indicates if the current unit can be deleted from the list of working set of objects. When you simply remove an object from the page-by, the object can still be used in other parts of the report/document definition. When you deleted from the working-set, though, the report definition changes, the unit is not available anymore and the report gets re-executed with the new definition.

This method should check for privileges and other factors that might prevent changing the report/document defition and returns false if the unit cannot be removed.

Indicates if this is the first unit in the collection of page-by units.

Indicates if this is the last unit in the collection of page-by units.

Helper method that checks whether any pivot is available. This method also checks for privileges and returns false if a user doesn't have enough.

Indicates if pivoting to the corresponding axis is available for this unit. For example, documents support pivoting only to the page-by axis. This method also checks for privileges and returns false if a user doesn't have enough.

Indicates if the user can open the properties editor for this unit. This feature is only available for documents..

Indicates if the current unit can be removed from the list of page-by units. This method would return false if the unit is locked. It also checks for privileges and returns false if a user doesn't have enough.

Indicates if the current unit alias can be changed. This method would return false if the unit cannot be renamed. It also checks for privileges and returns false if a user doesn't have enough.

Indicates if sorting is available for this unit. For example, reports don't support sorting on page-by units.