Package com.microstrategy.web.objects
Interface WebSubscriptionLocationAttributes
-
- All Known Subinterfaces:
WebSubscriptionDeviceLocation,WebSubscriptionLocation
public interface WebSubscriptionLocationAttributesThis object exposes properties of aWebSubscriptionLocation- Since:
- MicroStrategy Web 7.5.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetAddressPrefix()Returns the address prefix that is defined as a part of the devicejava.lang.StringgetAddressSuffix()Returns the address suffix that is defined as a part of the devicejava.lang.StringgetPath()Returns the device's base path.booleanhasPath()Indicates if the device has a predefined path prefixbooleanisAddressPrefixBrowsable()Indicates if the address prefix that is defined in the device definition contains any macrosbooleanrequiresAddress()
-
-
-
Method Detail
-
requiresAddress
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
-
getAddressPrefix
java.lang.String getAddressPrefix()
Returns the address prefix that is defined as a part of the device- Returns:
- the address prefix
-
getAddressSuffix
java.lang.String getAddressSuffix()
Returns the address suffix that is defined as a part of the device- Returns:
- the address suffix
-
isAddressPrefixBrowsable
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
-
hasPath
boolean hasPath()
Indicates if the device has a predefined path prefix- Returns:
- value to if the device has an predefined path prefix
-
getPath
java.lang.String getPath()
Returns the device's base path.- Returns:
- the device's base path
-
-