public interface

RWGroupBys

com.microstrategy.web.objects.rw.RWGroupBys

Class Overview

A collection of GroupBy objects

Summary

Public Methods
abstract RWGroupBy add(String objectId, int objectType, String key, String beforeKey)
Adds new group by before specified key.
abstract RWGroupBy add(WebObjectInfo obj, String key, String beforeKey)
Adds new group by before specified key.
abstract RWGroupBy add(WebObjectInfo obj, String key, String beforeKey, String headerKey, String headerSubsectionKey, String footerKey, String footerSubsectionKey)
abstract boolean contains(WebObjectInfo ob)
Returns true if specified object already present in the group by collection
abstract RWGroupBy get(int i)
Gets i-th group by
abstract RWGroupBy getByKey(String key)
Returns group by with specified key
abstract RWGroupBy getByLevel(int level)
Returns a group by with specified level
abstract RWDefinition getRwDefinition()
Returns parent RW Document definition
abstract boolean hasInvalidUnits()
Returns true if there's group by not having associate section in definition.
abstract int indexOf(RWGroupBy groupBy)
Returns an index of the group by in the group by collection
abstract boolean isFirstPage()
Returns true if current data represent first group by page
abstract boolean isLastPage()
Returns true if current data represent last group by page
abstract void moveByKey(String key, String beforeKey)
Moves a group by in the group by collection.
abstract RWGroupBy removeByKey(String key)
Removes group by with specified key.
abstract int size()
Returns grup by collection size

Public Methods

public abstract RWGroupBy add (String objectId, int objectType, String key, String beforeKey)

Adds new group by before specified key. The group by will be initialized with passed object. This method also creates corresponding group by section.

Parameters
objectId an id of target object for new group by
objectType the type of target object for new group by
key group by key
beforeKey the key of group by object before which a new on shall be added
Returns
  • new group by object.
Throws
IllegalArgumentException if specified object does not belong to the default data set or if specified group by object already present in the collection

public abstract RWGroupBy add (WebObjectInfo obj, String key, String beforeKey)

Adds new group by before specified key. The group by will be initialized with passed object. This method also creates corresponding group by section.

Parameters
obj group by object
key group by key
beforeKey the key of group by object before which a new on shall be added
Returns
  • new group by object.
Throws
IllegalArgumentException if specified object does not belong to the default data set or if specified group by object already present in the collection

public abstract RWGroupBy add (WebObjectInfo obj, String key, String beforeKey, String headerKey, String headerSubsectionKey, String footerKey, String footerSubsectionKey)

public abstract boolean contains (WebObjectInfo ob)

Returns true if specified object already present in the group by collection

Parameters
ob object
Returns
  • true if specified object already present in the group by collection

public abstract RWGroupBy get (int i)

Gets i-th group by

Parameters
i indext
Returns
  • i-th group by

public abstract RWGroupBy getByKey (String key)

Returns group by with specified key

Parameters
key grpup by object key
Returns
  • group by with specified key

public abstract RWGroupBy getByLevel (int level)

Returns a group by with specified level

Parameters
level groupby level
Returns
  • a group by with specified level

public abstract RWDefinition getRwDefinition ()

Returns parent RW Document definition

Returns
  • parent RW Document definition

public abstract boolean hasInvalidUnits ()

Returns true if there's group by not having associate section in definition.

Returns
  • true if there's group by not having associate section in definition.

public abstract int indexOf (RWGroupBy groupBy)

Returns an index of the group by in the group by collection

Parameters
groupBy group by object
Returns
  • an index of group by object or -1 if this object does not belong to the collection.

public abstract boolean isFirstPage ()

Returns true if current data represent first group by page

Returns
  • true if current data represent first group by page

public abstract boolean isLastPage ()

Returns true if current data represent last group by page

Returns
  • true if current data represent last group by page

public abstract void moveByKey (String key, String beforeKey)

Moves a group by in the group by collection. Layout hierarchy is adjusted accordingly.

Parameters
key group by key
beforeKey the key of group by before which it shall be moved.

public abstract RWGroupBy removeByKey (String key)

Removes group by with specified key. This method also modify layout hierarchy accordingly. Namely the child of the group by section is reattached to its parent, then the group by section is removed

Parameters
key the group by key
Returns
  • removed group by object

public abstract int size ()

Returns grup by collection size

Returns
  • grup by collection size