# com.bea.wli.management.configuration
TimerEventGenChannelConfiguration Class

public class TimerEventGenChannelConfiguration
extends `Object`
implements `Serializable`

Represents a channel rule for a Timer Event Generator.

Rule Fields:

- effective - initial time to fire
- expiry - end time to fire
- frequency - how often to fire after effective

Other fields:

- channel - channel to send to if rules match
- comment - comment for this channel rule
- calendar-name - name of the business calendar used
- message-content - message to publish

Related Topics

``TimerEventGenConfigurationMBean``

Hierarchy
  `Object`
  `TimerEventGenChannelConfiguration`

All Implemented Interfaces
  `Serializable`

## Constructor Summary

TimerEventGenChannelConfiguration()

## Method Summary

`public `String`` | `getCalendarName`() Returns the business calendar name of the channel rule
`public `String`` | `getChannel`() Returns the Message Broker channel name of the channel rule
`public `String`` | `getComment`() Returns the comment of the channel rule
`public `String`` | `getEffective`() Returns the initial time of the channel rule
`public long` | `getEffectiveTimestamp`() Returns the initial time of the channel rule in milliseconds since January 1, 1970, 00:00:00 GMT
`public `String`` | `getExpiry`() Returns the expiry time of the channel rule
`public long` | `getExpiryTimestamp`() Returns the expiry time of the channel rule in milliseconds since January 1, 1970, 00:00:00 GMT
`public `String`` | `getFrequency`() Returns the frequency of the channel rule
`public `String`` | `getMessageContent`() Returns the message content to publish of the channel rule
`public `String`` | `getPublishAsUser`() Get the publishAsUser attribute
`public void` | `setCalendarName`(`String` calendarName) Set the business calendar name of the channel rule
`public void` | `setChannel`(`String` channel) Set the Message Broker channel name of this channel rule
`public void` | `setComment`(`String` comment) Set comment of the channel rule
`public void` | `setEffective`(`String` effective) Set the initial time of the channel rule.
`public void` | `setExpiry`(`String` expiry) Set the expiry time of the channel rule.
`public void` | `setFrequency`(`String` frequency) Set the frequency of the channel rule
`public void` | `setMessageContent`(`String` messageContent) Set the message content to publish of the channel rule
`public void` | `setPublishAsUser`(`String` publishAsUser) Set the publishAsUser attribute
`public `String`` | `toString`() Returns a string representation of this channel

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

## Constructor Detail

### TimerEventGenChannelConfiguration

    public TimerEventGenChannelConfiguration()

## Method Detail

### getCalendarName() Method

    public String getCalendarName()

Returns the business calendar name of the channel rule

#### Returns

the business calendar name

### getChannel() Method

    public String getChannel()

Returns the Message Broker channel name of the channel rule

#### Returns

the Message Broker channel name

### getComment() Method

    public String getComment()

Returns the comment of the channel rule

#### Returns

the comment

### getEffective() Method

    public String getEffective()

Returns the initial time of the channel rule

#### Returns

initial time

### getEffectiveTimestamp() Method

    public long getEffectiveTimestamp()

Returns the initial time of the channel rule in milliseconds since January 1, 1970, 00:00:00 GMT

#### Returns

initial time in milliseconds since January 1, 1970, 00:00:00 GMT

### getExpiry() Method

    public String getExpiry()

Returns the expiry time of the channel rule

#### Returns

expiry time

### getExpiryTimestamp() Method

    public long getExpiryTimestamp()

Returns the expiry time of the channel rule in milliseconds since January 1, 1970, 00:00:00 GMT

#### Returns

expiry time in milliseconds since January 1, 1970, 00:00:00 GMT

### getFrequency() Method

    public String getFrequency()

Returns the frequency of the channel rule

#### Returns

the frequency

### getMessageContent() Method

    public String getMessageContent()

Returns the message content to publish of the channel rule

#### Returns

the message to publish

### getPublishAsUser() Method

    public String getPublishAsUser()

Get the publishAsUser attribute

#### Returns

publishAsUser attribute

### setCalendarName(String) Method

    public void setCalendarName(String calendarName)

Set the business calendar name of the channel rule

#### Parameters

calendarName
  business calendar name

### setChannel(String) Method

    public void setChannel(String channel)

Set the Message Broker channel name of this channel rule

#### Parameters

channel
  name of the Message Broker channel

### setComment(String) Method

    public void setComment(String comment)

Set comment of the channel rule

#### Parameters

comment
  comment of the channel rule

### setEffective(String) Method

    public void setEffective(String effective)

Set the initial time of the channel rule. The String argument must be of format compatible with `java.text.SimpleDateFormat("MMMMM dd, yyyy hh:mm:ss a z")` or `java.text.SimpleDateFormat("dd MMMMM yyyy HH:mm:ss z")` (backward compatible). For more information, see documentation for `java.text.SimpleDateFormat`.

#### Parameters

effective
  the initial time

### setExpiry(String) Method

    public void setExpiry(String expiry)

Set the expiry time of the channel rule. The String argument must be of format compatible with `java.text.SimpleDateFormat("MMMMM dd, yyyy hh:mm:ss a z")` or `java.text.SimpleDateFormat("dd MMMMM yyyy HH:mm:ss z")` (backward compatible). For more information, see documentation for `java.text.SimpleDateFormat`.

#### Parameters

expiry
  the expiry time

### setFrequency(String) Method

    public void setFrequency(String frequency)

Set the frequency of the channel rule

#### Parameters

frequency
  how often to trigger the timer event

### setMessageContent(String) Method

    public void setMessageContent(String messageContent)

Set the message content to publish of the channel rule

#### Parameters

messageContent
  message to publish

### setPublishAsUser(String) Method

    public void setPublishAsUser(String publishAsUser)

Set the publishAsUser attribute

#### Parameters

publishAsUser
  property to set

### toString() Method

    public String toString()

Returns a string representation of this channel

Overrides
  `Object.toString()`