| com.microstrategy.web.objects.WebSubscriptionComponent |
Class Overview
This object represents the a generic Subscription component. All the subscription components defined derive from this interface.
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
com.microstrategy.utils.serialization.EnumWebPersistableState
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract String | getDescription() | ||||||||||
| abstract String | getID() | ||||||||||
| abstract String | getName() | ||||||||||
| abstract WebSessionInfo | getSessionInfo() | ||||||||||
| abstract int | getType() | ||||||||||
| abstract boolean | isPopulated() | ||||||||||
| abstract void |
populate()
used to populate the object if not already populated
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.utils.StringKey
| |||||||||||
|
From interface
com.microstrategy.utils.serialization.Persistable
| |||||||||||
Public Methods
public abstract String getDescription ()
Returns
- the description of the component
public abstract String getID ()
Returns
- the identifier of the component
public abstract String getName ()
Returns
- the name of the component
public abstract int getType ()
Returns
- the type of the component as defined in
EnumWebSubscriptionObjectTypes
public abstract boolean isPopulated ()
Returns
- boolean indicating whether the object has been populated
public abstract void populate ()
used to populate the object if not already populated
Throws
| WebObjectsException | Thrown if there is an error reading the object definition from the metadata |
|---|