public
interface
RWUserAttribute
implements RWUserObject| com.microstrategy.web.objects.rw.RWUserAttribute |
Class Overview
THIS INTERFACE IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE INTERFACE IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT. The RWUserAttribute class represents an additional derived attribute added to the grid or data set. Those attributes are not added to the data set working set but rather a kept in the separate collection.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | EV_DEFAULT | ||||||||||
| int | EV_GLOBAL | ||||||||||
| int | EV_LOCAL | ||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
addForm(String formId, String name, Integer index, String formula, Integer bft)
add a form to this derived attribute
| ||||||||||
| abstract int |
getArity()
returns arity of this derived attribute.
| ||||||||||
| abstract WebAttribute |
getAttribute()
get corresponding #WebAttribute object
| ||||||||||
| abstract int | getEvFlags() | ||||||||||
| abstract boolean |
isOLAP()
return whether this derived attribute is OLAP.
| ||||||||||
| abstract void |
removeForm(String formId)
remove form from this derived attribute
| ||||||||||
| abstract void |
updateForm(String formId, String name, String formula, Integer bft, Boolean isTokenStream, Boolean isDisplayForm)
update form of this derived attribute
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.microstrategy.utils.KeyedObject
| |||||||||||
|
From interface
com.microstrategy.web.objects.rw.RWDataSetItem
| |||||||||||
|
From interface
com.microstrategy.web.objects.rw.RWUserObject
| |||||||||||
Constants
public static final int EV_DEFAULT
Constant Value:
0
(0x00000000)
public static final int EV_GLOBAL
Constant Value:
2
(0x00000002)
public static final int EV_LOCAL
Constant Value:
1
(0x00000001)
Public Methods
public abstract void addForm (String formId, String name, Integer index, String formula, Integer bft)
add a form to this derived attribute
Parameters
| formId | id of the system form to add, null means to add a new managed form |
|---|---|
| name | name of the new managed form if formId is null |
| index | position of the form to add, null or 0 means to add back |
| formula | base form formula |
| bft | base form type |
public abstract int getArity ()
returns arity of this derived attribute.
Returns
- arity of this derived attribute
public abstract int getEvFlags ()
public abstract boolean isOLAP ()
return whether this derived attribute is OLAP.
Returns
- true for OLAP DA.
public abstract void removeForm (String formId)
remove form from this derived attribute
Parameters
| formId | id of the form to remove |
|---|
public abstract void updateForm (String formId, String name, String formula, Integer bft, Boolean isTokenStream, Boolean isDisplayForm)
update form of this derived attribute
Parameters
| formId | id of the form to update |
|---|---|
| name | new name |
| formula | new base form formula |
| bft | new base form type |
| isTokenStream | true to update formula with token stream |
| isDisplayForm | true to add the form to display forms collection, false to remove the form from display forms collection, null to do nothing |