blob: 4efd213e959fadbe6e5e98fc5279bdf3b4cba19f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>ScheduleExpression</title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<link rel="shortcut icon" href="/img/jakarta-favicon.ico">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ScheduleExpression";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../jakarta/ejb/Schedule.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/ejb/Schedules.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/ejb/ScheduleExpression.html" target="_top">Frames</a></li>
<li><a href="ScheduleExpression.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">jakarta.ejb</div>
<h2 title="Class ScheduleExpression" class="title">Class ScheduleExpression</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>jakarta.ejb.ScheduleExpression</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ScheduleExpression</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block"><p>
A calendar-based timeout expression for an enterprise bean timer.
</p>
<p>
Each attribute used to define a calendar-based timeout schedule has two overloaded setter methods, one that takes a
String and one that takes an int. The int version is merely a convenience method for setting the attribute in the
common case that the value is a simple integer value.
</p>
<p>
For example,
<pre>
scheduleExpression.second(10)
</pre>
is semantically equivalent to
<pre>
scheduleExpression.second("10")
</pre>
There are seven attributes that constitute a schedule specification which are listed below. In addition, the
<code>timezone</code> attribute may be used to specify a non-default time zone in whose context the schedule
specification is to be evaluated.
<p>
The attributes that specify the calendar-based schedule itself are as follows:
<ul>
<li>second : one or more seconds within a minute
<p>
Allowable values: [0,59]
<li>minute : one or more minutes within an hour
<p>
Allowable values : [0,59]
<li>hour : one or more hours within a day
<p>
Allowable values : [0,23]
<li>dayOfMonth : one or more days within a month
<p>
Allowable values:
<ul>
<li>[1,31]
<li>[-7, -1]
<li>"Last"
<li>{"1st", "2nd", "3rd", "4th", "5th", "Last"} {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"}
</ul>
<p>
"Last" means the last day of the month
<p>
-x (where x is in the range [-7, -1]) means x day(s) before the last day of the month
<p>
"1st","2nd", etc. applied to a day of the week identifies a single occurrence of that day within the month.
<li>month : one or more months within a year
<p>
Allowable values :
<ul>
<li>[1,12]
<li>{"Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", Dec"}
</ul>
<li>dayOfWeek : one or more days within a week
<p>
Allowable values :
<ul>
<li>[0,7]
<li>{"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"}
</ul>
<p>
"0" and "7" both refer to Sunday
<li>year : a particular calendar year
<p>
Allowable values : a four-digit calendar year
<p>
</ul>
<p>
Each attribute supports values expressed in one of the following forms
<ul>
<li>Single Value. This constrains the attribute to only one of its possible values.
<pre>
Example: second = "10"
Example: month = "Sep"
</pre>
<li>Wild Card. "*" represents all allowable values for a given attribute.
<pre>
Example: second = "*"
Example: dayOfWeek = "*"
</pre>
<li>List. This constrains the attribute to two or more allowable values or ranges, with a comma used as a separator
character within the string. Each item in the list must be a single value or range. List items cannot be lists, wild
cards, or increments. Duplicate values are ignored.
<pre>
Example: second = "10,20,30"
Example: dayOfWeek = "Mon,Wed,Fri"
Example: minute = "0-10,30,40"
</pre>
<li>Range. This constrains the attribute to an inclusive range of values, with a dash separating both ends of the
range. Each side of the range must be a single attribute value. Members of a range cannot be lists, wild cards,
ranges, or increments. If <code>x</code> is larger than <code>y</code> in a range <code>"x-y"</code>, the range is
equivalent to <code>"x-max, min-y"</code>, where <code>max</code> is the largest value of the corresponding attribute
and <code>min</code> is the smallest. The range <code>"x-x"</code>, where both range values are the same, evaluates
to the single value <code>x</code>. The day of the week range <code>"0-7"</code> is equivalent to <code>"*"</code>.
<pre>
Example: second = "1-10"
Example: dayOfWeek = "Fri-Mon"
Example: dayOfMonth = "27-3" (Equivalent to "27-Last , 1-3")
</pre>
<li>Increments. The forward slash constrains an attribute based on a starting point and an interval, and is used to
specify every <code>N</code> seconds, minutes, or hours within the minute, hour, or day, respectively. For the
expression <code>x/y</code>, the attribute is constrained to every <code>y</code>th value within the set of allowable
values beginning at time <code>x</code>. The <code>x</code> value is inclusive. The wild card character
(<code>*</code>) can be used in the <code>x</code> position, and is equivalent to <code>0</code>. The use of
increments is only supported within the <code>second</code>, <code>minute</code>, and <code>hour</code> attributes.
For the <code>second</code> and <code>minute</code> attributes, <code>x</code> and <code>y</code> must each be in the
range <code>[0,59]</code>. For the <code>hour</code> attribute, <code>x</code> and <code>y</code> must each be in the
range <code>[0,23]</code>.
<pre>
Example: minute = "&#8727;/5" (Every five minutes within the hour)
</pre>
This is equivalent to: <code>minute = "0,5,10,15,20,25,30,35,40,45,50,55"</code>
<pre>
Example: second = "30/10" (Every 10 seconds within the minute, starting at second 30)
</pre>
This is equivalent to: <code>second = "30,40,50"</code>
<p>
Note that the set of matching increment values stops once the maximum value for that attribute is exceeded. It does
not "roll over" past the boundary.
<pre>
Example : ( minute = "&#8727;/14", hour="1,2")
</pre>
<p>
This is equivalent to: <code>(minute = "0,14,28,42,56", hour = "1,2")</code> (Every 14 minutes within the hour, for
the hours of 1 and 2 a.m.)
</ul>
<p>
The following additional rules apply to the schedule specification attributes:
<ul>
<li>If the <code>dayOfMonth</code> attribute has a non-wildcard value and the <code>dayOfWeek</code> attribute has a
non-wildcard value, then any day matching either the <code>dayOfMonth</code> value or the <code>dayOfWeek</code>
value will be considered to apply.
<li>Whitespace is ignored, except for string constants and numeric values.
<li>All string constants (e.g., <code>"Sun"</code>, <code>"Jan"</code>, <code>"1st"</code>, etc.) are case
insensitive.
</ul>
<p>
Schedule-based timer times are evaluated in the context of the default time zone associated with the container in
which the application is executing. A schedule-based timer may optionally override this default and associate itself
with a specific time zone. If the schedule-based timer is associated with a specific time zone, all its times are
evaluated in the context of that time zone, regardless of the default time zone in which the container is executing.
<p>
None of the ScheduleExpression methods are required to be called. The defaults are :
<ul>
<li>second: "0"
<li>minute: "0"
<li>hour: "0"
<li>dayOfMonth: "*"
<li>month: "*"
<li>dayOfWeek: "*"
<li>year: "*"
<li>timezone : default JVM time zone
<li>start : upon timer creation
<li>end : no end date
</ul>
<p>
Applications must not rely on the getter methods that return the attributes of a calendar-based timeout schedule to
return them in the same syntactic format in which they were passed in to a <code>ScheduleExpression</code> method or
supplied to the <code>Schedule</code> annotation, and portable implementations must not assume any particular
syntactic format. Implementations are required only to preserve semantic equivalence.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>EJB 3.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../serialized-form.html#jakarta.ejb.ScheduleExpression">Serialized Form</a></dd>
<dt><span class="simpleTagLabel">Examples (en):</span></dt>
<dd><a href="../../../../../tomee-9.0/examples/schedule-expression.html">schedule-expression</a>, <a href="../../../../../tomee-9.0/examples/schedule-events.html">schedule-events</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#ScheduleExpression--">ScheduleExpression</a></span>()</code>
<div class="block">Create a schedule with the default values.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#dayOfMonth-int-">dayOfMonth</a></span>(int&nbsp;d)</code>
<div class="block">Set the day of the month attribute.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#dayOfMonth-java.lang.String-">dayOfMonth</a></span>(java.lang.String&nbsp;d)</code>
<div class="block">Set the day of the month attribute.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#dayOfWeek-int-">dayOfWeek</a></span>(int&nbsp;d)</code>
<div class="block">Set the day of the week attribute.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#dayOfWeek-java.lang.String-">dayOfWeek</a></span>(java.lang.String&nbsp;d)</code>
<div class="block">Set the day of the week attribute.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#end-java.util.Date-">end</a></span>(java.util.Date&nbsp;e)</code>
<div class="block">Set the end date.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#getDayOfMonth--">getDayOfMonth</a></span>()</code>
<div class="block">Return the value of the day of the month attribute.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#getDayOfWeek--">getDayOfWeek</a></span>()</code>
<div class="block">Return the value of the day of the week attribute.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.util.Date</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#getEnd--">getEnd</a></span>()</code>
<div class="block">Return the end date, if set; otherwise null.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#getHour--">getHour</a></span>()</code>
<div class="block">Return the value of the hour attribute.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#getMinute--">getMinute</a></span>()</code>
<div class="block">Return the value of the minute attribute.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#getMonth--">getMonth</a></span>()</code>
<div class="block">Return the value of the month attribute.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#getSecond--">getSecond</a></span>()</code>
<div class="block">Return the value of the second attribute.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.util.Date</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#getStart--">getStart</a></span>()</code>
<div class="block">Return the start date, if set; otherwise null.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#getTimezone--">getTimezone</a></span>()</code>
<div class="block">Return the timezone, if set; otherwise null.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#getYear--">getYear</a></span>()</code>
<div class="block">Return the value of the year attribute.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#hour-int-">hour</a></span>(int&nbsp;h)</code>
<div class="block">Set the hour attribute.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#hour-java.lang.String-">hour</a></span>(java.lang.String&nbsp;h)</code>
<div class="block">Set the hour attribute.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#minute-int-">minute</a></span>(int&nbsp;m)</code>
<div class="block">Set the minute attribute.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#minute-java.lang.String-">minute</a></span>(java.lang.String&nbsp;m)</code>
<div class="block">Set the minute attribute.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#month-int-">month</a></span>(int&nbsp;m)</code>
<div class="block">Set the month attribute.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#month-java.lang.String-">month</a></span>(java.lang.String&nbsp;m)</code>
<div class="block">Set the month attribute.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#second-int-">second</a></span>(int&nbsp;s)</code>
<div class="block">Set the second attribute.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#second-java.lang.String-">second</a></span>(java.lang.String&nbsp;s)</code>
<div class="block">Set the second attribute.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#start-java.util.Date-">start</a></span>(java.util.Date&nbsp;s)</code>
<div class="block">Set the start date.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#timezone-java.lang.String-">timezone</a></span>(java.lang.String&nbsp;timezoneID)</code>
<div class="block">Set the timezone.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#toString--">toString</a></span>()</code></td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#year-int-">year</a></span>(int&nbsp;y)</code>
<div class="block">Set the year attribute.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/ejb/ScheduleExpression.html#year-java.lang.String-">year</a></span>(java.lang.String&nbsp;y)</code>
<div class="block">Set the year attribute.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ScheduleExpression--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ScheduleExpression</h4>
<pre>public&nbsp;ScheduleExpression()</pre>
<div class="block">Create a schedule with the default values.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="second-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>second</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;second(java.lang.String&nbsp;s)</pre>
<div class="block">Set the second attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the attribute value as a <code>String</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="second-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>second</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;second(int&nbsp;s)</pre>
<div class="block">Set the second attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the attribute value as an <code>int</code>, if the value is a simple integer value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="getSecond--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSecond</h4>
<pre>public&nbsp;java.lang.String&nbsp;getSecond()</pre>
<div class="block">Return the value of the second attribute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>second</dd>
</dl>
</li>
</ul>
<a name="minute-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minute</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;minute(java.lang.String&nbsp;m)</pre>
<div class="block">Set the minute attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>m</code> - the attribute value as a <code>String</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="minute-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minute</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;minute(int&nbsp;m)</pre>
<div class="block">Set the minute attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>m</code> - the attribute value as an <code>int</code>, if the value is a simple integer value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="getMinute--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinute</h4>
<pre>public&nbsp;java.lang.String&nbsp;getMinute()</pre>
<div class="block">Return the value of the minute attribute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>minute</dd>
</dl>
</li>
</ul>
<a name="hour-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hour</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;hour(java.lang.String&nbsp;h)</pre>
<div class="block">Set the hour attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>h</code> - the attribute value as a <code>String</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="hour-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hour</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;hour(int&nbsp;h)</pre>
<div class="block">Set the hour attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>h</code> - the attribute value as an <code>int</code>, if the value is a simple integer value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="getHour--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHour</h4>
<pre>public&nbsp;java.lang.String&nbsp;getHour()</pre>
<div class="block">Return the value of the hour attribute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>hour</dd>
</dl>
</li>
</ul>
<a name="dayOfMonth-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dayOfMonth</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;dayOfMonth(java.lang.String&nbsp;d)</pre>
<div class="block">Set the day of the month attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>d</code> - the attribute value as a <code>String</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="dayOfMonth-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dayOfMonth</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;dayOfMonth(int&nbsp;d)</pre>
<div class="block">Set the day of the month attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>d</code> - the attribute value as an <code>int</code>, if the value is a simple integer value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="getDayOfMonth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDayOfMonth</h4>
<pre>public&nbsp;java.lang.String&nbsp;getDayOfMonth()</pre>
<div class="block">Return the value of the day of the month attribute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>day of the month</dd>
</dl>
</li>
</ul>
<a name="month-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>month</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;month(java.lang.String&nbsp;m)</pre>
<div class="block">Set the month attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>m</code> - the attribute value as a <code>String</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="month-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>month</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;month(int&nbsp;m)</pre>
<div class="block">Set the month attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>m</code> - the attribute value as an <code>int</code>, if the value is a simple integer value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="getMonth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMonth</h4>
<pre>public&nbsp;java.lang.String&nbsp;getMonth()</pre>
<div class="block">Return the value of the month attribute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>month</dd>
</dl>
</li>
</ul>
<a name="dayOfWeek-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dayOfWeek</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;dayOfWeek(java.lang.String&nbsp;d)</pre>
<div class="block">Set the day of the week attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>d</code> - the attribute value as a <code>String</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="dayOfWeek-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dayOfWeek</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;dayOfWeek(int&nbsp;d)</pre>
<div class="block">Set the day of the week attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>d</code> - the attribute value as an <code>int</code>, if the value is a simple integer value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="getDayOfWeek--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDayOfWeek</h4>
<pre>public&nbsp;java.lang.String&nbsp;getDayOfWeek()</pre>
<div class="block">Return the value of the day of the week attribute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>day of the week</dd>
</dl>
</li>
</ul>
<a name="year-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>year</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;year(java.lang.String&nbsp;y)</pre>
<div class="block">Set the year attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>y</code> - the attribute value as a <code>String</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="year-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>year</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;year(int&nbsp;y)</pre>
<div class="block">Set the year attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>y</code> - the attribute value as an <code>int</code>, if the value is a simple integer value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="getYear--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getYear</h4>
<pre>public&nbsp;java.lang.String&nbsp;getYear()</pre>
<div class="block">Return the value of the year attribute.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>year</dd>
</dl>
</li>
</ul>
<a name="timezone-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>timezone</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;timezone(java.lang.String&nbsp;timezoneID)</pre>
<div class="block">Set the timezone.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timezoneID</code> - the Time zone specified as an ID String</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="getTimezone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimezone</h4>
<pre>public&nbsp;java.lang.String&nbsp;getTimezone()</pre>
<div class="block">Return the timezone, if set; otherwise null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>timezone</dd>
</dl>
</li>
</ul>
<a name="start-java.util.Date-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;start(java.util.Date&nbsp;s)</pre>
<div class="block">Set the start date.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>s</code> - the start date</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="getStart--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStart</h4>
<pre>public&nbsp;java.util.Date&nbsp;getStart()</pre>
<div class="block">Return the start date, if set; otherwise null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>start date</dd>
</dl>
</li>
</ul>
<a name="end-java.util.Date-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>end</h4>
<pre>public&nbsp;<a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb">ScheduleExpression</a>&nbsp;end(java.util.Date&nbsp;e)</pre>
<div class="block">Set the end date.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>e</code> - the end date</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../jakarta/ejb/ScheduleExpression.html" title="class in jakarta.ejb"><code>ScheduleExpression</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="getEnd--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnd</h4>
<pre>public&nbsp;java.util.Date&nbsp;getEnd()</pre>
<div class="block">Return the end date, if set; otherwise null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>end date</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../jakarta/ejb/Schedule.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/ejb/Schedules.html" title="annotation in jakarta.ejb"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/ejb/ScheduleExpression.html" target="_top">Frames</a></li>
<li><a href="ScheduleExpression.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>