public interface

WebSubscriptionLocationAttributes

com.microstrategy.web.objects.WebSubscriptionLocationAttributes
Known Indirect Subclasses

Class Overview

This object exposes properties of a WebSubscriptionLocation

Summary

Public Methods
abstract String getAddressPrefix()
Returns the address prefix that is defined as a part of the device
abstract String getAddressSuffix()
Returns the address suffix that is defined as a part of the device
abstract String getPath()
Returns the device's base path.
abstract boolean hasPath()
Indicates if the device has a predefined path prefix
abstract boolean isAddressPrefixBrowsable()
Indicates if the address prefix that is defined in the device definition contains any macros
abstract boolean requiresAddress()

Public Methods

public abstract String getAddressPrefix ()

Returns the address prefix that is defined as a part of the device

Returns
  • the address prefix

public abstract String getAddressSuffix ()

Returns the address suffix that is defined as a part of the device

Returns
  • the address suffix

public abstract String getPath ()

Returns the device's base path.

Returns
  • the device's base path

public abstract boolean hasPath ()

Indicates if the device has a predefined path prefix

Returns
  • value to if the device has an predefined path prefix

public abstract boolean isAddressPrefixBrowsable ()

Indicates if the address prefix that is defined in the device definition contains any macros

Returns
  • value to indicate if the address prefix that is defined in the device definition contains any macros

public abstract boolean requiresAddress ()

Returns
  • whether this device requires the user to type in an absolute/relative address. For instance, in the case of a file location, depending on the type of device used, the user may or may not need to enter a path for where his file will be saved