public interface

WebSubscriptionLocation

implements StringKey WebSubscriptionLocationAttributes
com.microstrategy.web.objects.WebSubscriptionLocation

Class Overview

This object is an abstraction of an address and a device. In other words, location can represent either an underlying address or a device This allows clients to handle both in a more uniform way This is espically useful for print and file addresses.

Summary

Public Methods
abstract WebSubscriptionAddress getAddress()
Returns the address, if any, that is associated with this location
abstract WebSubscriptionDevice getDevice()
Returns the device associated with this location Note that if there is an address associated with this location, then the result of this is the same as this.getAddress().getDevice()
abstract String getDisplayName()
Return a display name for this location This will be either the name of the device, in case where there is no address associated with this or if there is an associated address, this will be the name of the address
[Expand]
Inherited Methods
From interface com.microstrategy.utils.StringKey
From interface com.microstrategy.web.objects.WebSubscriptionLocationAttributes

Public Methods

public abstract WebSubscriptionAddress getAddress ()

Returns the address, if any, that is associated with this location

Returns
  • the address, if any, that is associated with this location
Throws
WebObjectsException

public abstract WebSubscriptionDevice getDevice ()

Returns the device associated with this location Note that if there is an address associated with this location, then the result of this is the same as this.getAddress().getDevice()

Returns
  • the device associated with this location
Throws
WebObjectsException

public abstract String getDisplayName ()

Return a display name for this location This will be either the name of the device, in case where there is no address associated with this or if there is an associated address, this will be the name of the address

Returns
  • a display name for this location