public interface

WebSubscriptionDeliveryModePrintProperties

implements WebSubscriptionDeliveryModeProperties
com.microstrategy.web.objects.WebSubscriptionDeliveryModePrintProperties

Class Overview

Each subscription is associated with a delivery mode. Each delivery mode may define specific properties, which are encapsulated by the relevant WebSubscriptionDeliveryModeProperties sub-interface.

This sub-interface is specifically for print deliveries

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.objects.EnumWebSubscriptionDeliveryMode
Public Methods
abstract int getCopies()
Retrieves the number of copies that should be printed
abstract int getRangeEnd()
Retrieves the number indicating the last report page that should be printed
abstract int getRangeStart()
Retrieves the number indicating the first report page that should be printed
abstract boolean isCollated()
Indicates whether the printing should be collated
abstract boolean isPortrait()
abstract void setCollate(boolean collate)
sets a parameter indicating whether printing should be collated
abstract void setCopies(int copies)
Sets the number of copies that should be printed
abstract void setPortrait(boolean isPortrait)
abstract void setRangeEnd(int end)
sets the number indicating the last report page that should be printed.
abstract void setRangeStart(int start)
Sets the number indicating the first report page that should be printed Note that this will take effect only if setUsePrintRange(boolean) is set to true
abstract void setUsePrintRange(boolean usePrintRange)
Sets whether a print range should be used.
abstract boolean usePrintRange()
Returns whether a print range should be used.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebSubscriptionDeliveryModeProperties

Public Methods

public abstract int getCopies ()

Retrieves the number of copies that should be printed

Returns
  • the number of copies that should be printed

public abstract 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

public abstract 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

public abstract boolean isCollated ()

Indicates whether the printing should be collated

Returns
  • true if the printing should be collated

public abstract boolean isPortrait ()

Returns
  • whether orientation is portrait or landscape

public abstract void setCollate (boolean collate)

sets a parameter indicating whether printing should be collated

Parameters
collate indicates whether the printing should be collated

public abstract void setCopies (int copies)

Sets the number of copies that should be printed

Parameters
copies the number of copies that should be printed

public abstract void setPortrait (boolean isPortrait)

public abstract void setRangeEnd (int end)

sets the number indicating the last report page that should be printed. Note that this will take effect only if setUsePrintRange(boolean) is set to true

Parameters
end the number indicating the last report page that should be printed

public abstract void setRangeStart (int start)

Sets the number indicating the first report page that should be printed Note that this will take effect only if setUsePrintRange(boolean) is set to true

Parameters
start the number indicating the first report page that should be printed

public abstract void setUsePrintRange (boolean usePrintRange)

Sets whether a print range should be used.

public abstract boolean usePrintRange ()

Returns whether a print range should be used.