public interface

RWGroupByElements

com.microstrategy.web.objects.rw.RWGroupByElements

Class Overview

Represents collection of group by elements

Summary

Constants
String ALL_ID
Public Methods
abstract void add(RWGroupByElement element, int position)
Inserts element into specified position
abstract void add(RWGroupByElement element)
Adds element to collection
abstract RWGroupByElement addElement(int type, String id, String displayName)
Creates and adds element to the collection
abstract boolean contains(String id)
Returns true if the collection contains element with specified ID
abstract RWGroupByElement get(int i)
REturns i-th collection element
abstract RWGroupByElement get(String id)
Returns an element with specified id or null
abstract RWGroupByElement getCurrentElement()
Returns the current element of the template unit, if specified, or null if it is unspecified.
abstract RWGroupByUnit getUnit()
Returns group by unit this collection belongs to
abstract RWGroupByElements newInstance()
Creates new instance of element collection
abstract int size()
Returns number of elements in the collection

Constants

public static final String ALL_ID

Constant Value: "u;"

Public Methods

public abstract void add (RWGroupByElement element, int position)

Inserts element into specified position

Parameters
element element
position position

public abstract void add (RWGroupByElement element)

Adds element to collection

Parameters
element element

public abstract RWGroupByElement addElement (int type, String id, String displayName)

Creates and adds element to the collection

Parameters
type element type
id element ID
displayName element display name
Returns
  • new element

public abstract boolean contains (String id)

Returns true if the collection contains element with specified ID

Parameters
id element ID
Returns
  • true if the collection contains element with specified ID

public abstract RWGroupByElement get (int i)

REturns i-th collection element

Parameters
i index
Returns
  • i-th collection element

public abstract RWGroupByElement get (String id)

Returns an element with specified id or null

Parameters
id element id
Returns
  • an element with specified id or null

public abstract RWGroupByElement getCurrentElement ()

Returns the current element of the template unit, if specified, or null if it is unspecified.

Returns
  • A WebElement which describes the current element of the template unit.

public abstract RWGroupByUnit getUnit ()

Returns group by unit this collection belongs to

Returns
  • RWGroupByUnit

public abstract RWGroupByElements newInstance ()

Creates new instance of element collection

Returns
  • element collection

public abstract int size ()

Returns number of elements in the collection

Returns
  • number of elements in the collection