Package com.microstrategy.web.objects.rw
Interface RWGroupByElements
-
public interface RWGroupByElements
Represents collection of group by elements- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ALL_ID
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
add(RWGroupByElement element)
Adds element to collectionvoid
add(RWGroupByElement element, int position)
Inserts element into specified positionRWGroupByElement
addElement(int type, java.lang.String id, java.lang.String displayName)
Creates and adds element to the collectionboolean
contains(java.lang.String id)
Returns true if the collection contains element with specified IDRWGroupByElement
get(int i)
REturns i-th collection elementRWGroupByElement
get(java.lang.String id)
Returns an element with specified id or nullRWGroupByElement
getCurrentElement()
Returns the current element of the template unit, if specified, or null if it is unspecified.RWGroupByUnit
getUnit()
Returns group by unit this collection belongs toRWGroupByElements
newInstance()
Creates new instance of element collectionint
size()
Returns number of elements in the collection
-
-
-
Field Detail
-
ALL_ID
static final java.lang.String ALL_ID
- Since:
- MicroStrategy Web 8.1.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
size
int size()
Returns number of elements in the collection- Returns:
- number of elements in the collection
-
get
RWGroupByElement get(int i)
REturns i-th collection element- Parameters:
i
- index- Returns:
- i-th collection element
-
get
RWGroupByElement get(java.lang.String id)
Returns an element with specified id or null- Parameters:
id
- element id- Returns:
- an element with specified id or null
-
getCurrentElement
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.
-
getUnit
RWGroupByUnit getUnit()
Returns group by unit this collection belongs to- Returns:
- RWGroupByUnit
-
contains
boolean contains(java.lang.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
- Since:
- MicroStrategy Web 8.1.0
-
addElement
RWGroupByElement addElement(int type, java.lang.String id, java.lang.String displayName)
Creates and adds element to the collection- Parameters:
type
- element typeid
- element IDdisplayName
- element display name- Returns:
- new element
- Since:
- MicroStrategy Web 8.1.0
-
add
void add(RWGroupByElement element)
Adds element to collection- Parameters:
element
- element- Since:
- MicroStrategy Web 8.1.0
-
add
void add(RWGroupByElement element, int position)
Inserts element into specified position- Parameters:
element
- elementposition
- position- Since:
- MicroStrategy Web 8.1.0
-
newInstance
RWGroupByElements newInstance()
Creates new instance of element collection- Returns:
- element collection
- Since:
- MicroStrategy Web 8.1.0
-
-