WebSubscriptionComponent (Web API 2021)

All Superinterfaces:

EnumWebPersistableState, Persistable, StringKey

All Known Subinterfaces:

WebIServerSubscriptionDevice, WebIServerSubscriptionTrigger, WebSubscription, WebSubscriptionAddress, WebSubscriptionAnswer, WebSubscriptionContact, WebSubscriptionContent, WebSubscriptionContentDocument, WebSubscriptionContentReport, WebSubscriptionDevice, WebSubscriptionDeviceLocation, WebSubscriptionDynamicRecipientList, WebSubscriptionTrigger

All Known Implementing Classes:

WebIServerSubscriptionDynamicRecipientListImpl
```
public interface WebSubscriptionComponent
extends Persistable, StringKey
```
This object represents the a generic Subscription component. All the subscription components defined derive from this interface.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary
- Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
  BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getDescription()`
`java.lang.String`	`getID()`
`java.lang.String`	`getName()`
`WebSessionInfo`	`getSessionInfo()`
`int`	`getType()`
`boolean`	`isPopulated()`
`void`	`populate()`	used to populate the object if not already populated

Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.utils.StringKey
getStringKey

- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns:
    
    the name of the component
  - getDescription
```
java.lang.String getDescription()
```
    Returns:
    
    the description of the component
  - getID
```
java.lang.String getID()
```
    Returns:
    
    the identifier of the component
  - getType
```
int getType()
```
    Returns:
    
    the type of the component as defined in EnumWebSubscriptionObjectTypes
  - getSessionInfo
```
WebSessionInfo getSessionInfo()
```
    Returns:
    
    the associated WebSessionInfo object
  - isPopulated
```
boolean isPopulated()
```
    Returns:
    
    boolean indicating whether the object has been populated
  - populate
```
void populate()
       throws WebObjectsException
```
    used to populate the object if not already populated
    
    Throws:
    
    WebObjectsException - Thrown if there is an error reading the object definition from the metadata