Package com.microstrategy.web.objects
Interface WebSubscriptionDeliveryModePrintProperties
-
- All Superinterfaces:
EnumWebPersistableState
,EnumWebSubscriptionDeliveryMode
,Persistable
,WebSubscriptionDeliveryModeProperties
public interface WebSubscriptionDeliveryModePrintProperties extends WebSubscriptionDeliveryModeProperties
Each subscription is associated with a delivery mode. Each delivery mode may define specific properties, which are encapsulated by the relevant
This sub-interface is specifically for print deliveriesWebSubscriptionDeliveryModeProperties
sub-interface.- Since:
- MicroStrategy Web 7.5.1
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
Fields inherited from interface com.microstrategy.web.objects.EnumWebSubscriptionDeliveryMode
SUBSCRIPTION_DELIVERY_MODE_EMAIL, SUBSCRIPTION_DELIVERY_MODE_FILE, SUBSCRIPTION_DELIVERY_MODE_INBOX, SUBSCRIPTION_DELIVERY_MODE_PRINT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getCopies()
Retrieves the number of copies that should be printedint
getRangeEnd()
Retrieves the number indicating the last report page that should be printedint
getRangeStart()
Retrieves the number indicating the first report page that should be printedboolean
isCollated()
Indicates whether the printing should be collatedboolean
isPortrait()
void
setCollate(boolean collate)
sets a parameter indicating whether printing should be collatedvoid
setCopies(int copies)
Sets the number of copies that should be printedvoid
setPortrait(boolean isPortrait)
void
setRangeEnd(int end)
sets the number indicating the last report page that should be printed.void
setRangeStart(int start)
Sets the number indicating the first report page that should be printed Note that this will take effect only ifsetUsePrintRange(boolean)
is set totrue
void
setUsePrintRange(boolean usePrintRange)
Sets whether a print range should be used.boolean
usePrintRange()
Returns whether a print range should be used.-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
Methods inherited from interface com.microstrategy.web.objects.WebSubscriptionDeliveryModeProperties
clone, getContactSecurity, getExecutionFlags, getExpiration, getMode, setContactSecurity, setExecutionFlags, setExpiration
-
-
-
-
Method Detail
-
getCopies
int getCopies()
Retrieves the number of copies that should be printed- Returns:
- the number of copies that should be printed
-
setCopies
void setCopies(int copies)
Sets the number of copies that should be printed- Parameters:
copies
- the number of copies that should be printed
-
getRangeStart
int getRangeStart()
Retrieves the number indicating the first report page that should be printed- Returns:
- the number indicating the first report page that should be printed
-
setRangeStart
void setRangeStart(int start)
Sets the number indicating the first report page that should be printed Note that this will take effect only ifsetUsePrintRange(boolean)
is set totrue
- Parameters:
start
- the number indicating the first report page that should be printed
-
getRangeEnd
int getRangeEnd()
Retrieves the number indicating the last report page that should be printed- Returns:
- the number indicating the first report page that should be printed
-
setRangeEnd
void setRangeEnd(int end)
sets the number indicating the last report page that should be printed. Note that this will take effect only ifsetUsePrintRange(boolean)
is set totrue
- Parameters:
end
- the number indicating the last report page that should be printed
-
isPortrait
boolean isPortrait()
- Returns:
- whether orientation is portrait or landscape
-
setPortrait
void setPortrait(boolean isPortrait)
- Parameters:
isPortrait
-
-
isCollated
boolean isCollated()
Indicates whether the printing should be collated- Returns:
- true if the printing should be collated
-
setCollate
void setCollate(boolean collate)
sets a parameter indicating whether printing should be collated- Parameters:
collate
- indicates whether the printing should be collated
-
usePrintRange
boolean usePrintRange()
Returns whether a print range should be used.- Since:
- MicroStrategy Web 9.0.0
-
setUsePrintRange
void setUsePrintRange(boolean usePrintRange)
Sets whether a print range should be used.- Parameters:
usePrintRange
-- Since:
- MicroStrategy Web 9.0.0
-
-