oracle.syndicate.message.offer
Interface DeliveryRule

public interface DeliveryRule

Provides accessors for the delivery rule attributes of an offer

Since:

release specific (what release of product did this appear in)

Field Summary

static java.lang.String	DELIVERY_RULE_MODE_PULL PULL mode identifier
static java.lang.String	DELIVERY_RULE_MODE_PUSH PUSH mode identifier
static int	ICE_PACKAGE_FORMAT ICE PACKAGE FORMAT
static int	NON_ICE_NO_LOG_PACKAGE_FORMAT NON ICE NO LOG PACKAGE FORMAT
static int	NON_ICE_PACKAGE_FORMAT NON ICE PACKAGE FORMAT

Method Summary

ISODuration	getDuration() Returns the DeliveryRule duration
int	getMaxNumUpdates() Returns Delivery Rule maximum number of updates or -1 if undefined
ISODuration	getMaxUpdateInterval() Returns Delivery Rule maximum update interval or null if undefined
int	getMinNumUpdates() Returns Delivery Rule minimum number of updates or -1 if undefined
ISODuration	getMinUpdateInterval() Returns Delivery Rule minimum update interval or null if undefined
java.lang.String	getMode() Returns Delivery Rule mode: pull or push
java.lang.String	getMonthDay() Returns the delivery rule month day identifying the days of the month when the delivery will be allowed.
int	getPackageFormat() Returns the format of the package
java.lang.String	getPushAuthPassword() Returns the password to be used when pushing content to the supplied push URL.
java.lang.String	getPushAuthUsername() Returns the username to be used when pushing content to the supplied push URL.
ISODateTime	getStartDate() Returns Delivery Rule start date or null if undefined.
ISOTime	getStartTime() Returns Delivery Rule start time or null if undefined.
ISODateTime	getStopDate() Returns Delivery Rule stop date or null if undefined.
java.lang.String	getURL() Returns Delivery Rule push URL
java.lang.String	getWeekDay() Returns the delivery rule week day identifying the days of the week when the delivery will be allowed.
void	setPackageFormat(int packageFormat) Sets the format of the package
void	setPushAuthPassword(java.lang.String passWord) Sets the password to be used when pushing content to the supplied push URL.
void	setPushAuthUsername(java.lang.String userName) Sets the username to be used when pushing content to the supplied push URL.
void	setURL(java.lang.String url) Sets the Delivery Rule push URL

Field Detail

DELIVERY_RULE_MODE_PULL

public static final java.lang.String DELIVERY_RULE_MODE_PULL

PULL mode identifier

DELIVERY_RULE_MODE_PUSH

public static final java.lang.String DELIVERY_RULE_MODE_PUSH

PUSH mode identifier

ICE_PACKAGE_FORMAT

public static final int ICE_PACKAGE_FORMAT

ICE PACKAGE FORMAT

NON_ICE_PACKAGE_FORMAT

public static final int NON_ICE_PACKAGE_FORMAT

NON ICE PACKAGE FORMAT

NON_ICE_NO_LOG_PACKAGE_FORMAT

public static final int NON_ICE_NO_LOG_PACKAGE_FORMAT

NON ICE NO LOG PACKAGE FORMAT

Method Detail

getDuration

public ISODuration getDuration()

Returns the DeliveryRule duration

getMaxNumUpdates

public int getMaxNumUpdates()

Returns Delivery Rule maximum number of updates or -1 if undefined

getMaxUpdateInterval

public ISODuration getMaxUpdateInterval()

Returns Delivery Rule maximum update interval or null if undefined

getMinNumUpdates

public int getMinNumUpdates()

Returns Delivery Rule minimum number of updates or -1 if undefined

getMinUpdateInterval

public ISODuration getMinUpdateInterval()

Returns Delivery Rule minimum update interval or null if undefined

getMode

public java.lang.String getMode()

Returns Delivery Rule mode: pull or push

getMonthDay

public java.lang.String getMonthDay()

Returns the delivery rule month day identifying the days of the month when the delivery will be allowed. The attribute is in the range of 1 to 31, or the special values "any" or "last".

getWeekDay

public java.lang.String getWeekDay()

Returns the delivery rule week day identifying the days of the week when the delivery will be allowed. The attribute is in the range of 1 (Monday) to 7 (Sunday), or the special value "any".

getStartDate

public ISODateTime getStartDate()

Returns Delivery Rule start date or null if undefined.

getStartTime

public ISOTime getStartTime()

Returns Delivery Rule start time or null if undefined.

getStopDate

public ISODateTime getStopDate()

Returns Delivery Rule stop date or null if undefined.

getURL

public java.lang.String getURL()

Returns Delivery Rule push URL

setURL

public void setURL(java.lang.String url)

Sets the Delivery Rule push URL

getPackageFormat

public int getPackageFormat()

Returns the format of the package

setPackageFormat

public void setPackageFormat(int packageFormat)

Sets the format of the package

getPushAuthUsername

public java.lang.String getPushAuthUsername()

Returns the username to be used when pushing content to the supplied push URL.

setPushAuthUsername

public void setPushAuthUsername(java.lang.String userName)

Sets the username to be used when pushing content to the supplied push URL.

getPushAuthPassword

public java.lang.String getPushAuthPassword()

Returns the password to be used when pushing content to the supplied push URL.

setPushAuthPassword

public void setPushAuthPassword(java.lang.String passWord)

Sets the password to be used when pushing content to the supplied push URL.