Package com.microstrategy.web.objects
Interface WebSubscriptionLocation
-
- All Superinterfaces:
StringKey
,WebSubscriptionLocationAttributes
public interface WebSubscriptionLocation extends WebSubscriptionLocationAttributes, StringKey
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.- Since:
- MicroStrategy Web 7.5.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebSubscriptionAddress
getAddress()
Returns the address, if any, that is associated with this locationWebSubscriptionDevice
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()java.lang.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-
Methods inherited from interface com.microstrategy.utils.StringKey
getStringKey
-
Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionLocationAttributes
getAddressPrefix, getAddressSuffix, getPath, hasPath, isAddressPrefixBrowsable, requiresAddress
-
-
-
-
Method Detail
-
getAddress
WebSubscriptionAddress getAddress() throws WebObjectsException
Returns the address, if any, that is associated with this location- Returns:
- the address, if any, that is associated with this location
- Throws:
WebObjectsException
-
getDevice
WebSubscriptionDevice getDevice() throws WebObjectsException
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
-
getDisplayName
java.lang.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
-
-