/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/application/ScheduledApplication.html is in libosgi-compendium-java-doc 4.3.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Wed Nov 09 19:45:53 UTC 2011 -->
<TITLE>
ScheduledApplication
</TITLE>
<META NAME="date" CONTENT="2011-11-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ScheduledApplication";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/osgi/service/application/ApplicationHandle.html" title="class in org.osgi.service.application"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/application/ScheduledApplication.html" target="_top"><B>FRAMES</B></A>
<A HREF="ScheduledApplication.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.osgi.service.application</FONT>
<BR>
Interface ScheduledApplication</H2>
<HR>
<DL>
<DT><PRE>public interface <B>ScheduledApplication</B></DL>
</PRE>
<P>
It is allowed to schedule an application based on a specific event.
ScheduledApplication service keeps the schedule information. When the
specified event is fired a new instance must be launched. Note that launching
operation may fail because e.g. the application is locked.
<p>
Each <code>ScheduledApplication</code> instance has an identifier which is
unique within the scope of the application being scheduled.
<p>
<code>ScheduledApplication</code> instances are registered as services. The
<A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#APPLICATION_PID"><CODE>APPLICATION_PID</CODE></A> service property contains the PID of the application
being scheduled, the <A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#SCHEDULE_ID"><CODE>SCHEDULE_ID</CODE></A> service property contains the
schedule identifier.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#APPLICATION_PID">APPLICATION_PID</A></B></CODE>
<BR>
The property key for the identifier of the application being scheduled.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#DAY_OF_MONTH">DAY_OF_MONTH</A></B></CODE>
<BR>
The name of the <i>day of month</i> attribute of a virtual timer event.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#DAY_OF_WEEK">DAY_OF_WEEK</A></B></CODE>
<BR>
The name of the <i>day of week</i> attribute of a virtual timer event.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#HOUR_OF_DAY">HOUR_OF_DAY</A></B></CODE>
<BR>
The name of the <i>hour of day</i> attribute of a virtual timer event.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#MINUTE">MINUTE</A></B></CODE>
<BR>
The name of the <i>minute</i> attribute of a virtual timer event.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#MONTH">MONTH</A></B></CODE>
<BR>
The name of the <i>month</i> attribute of a virtual timer event.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#SCHEDULE_ID">SCHEDULE_ID</A></B></CODE>
<BR>
The property key for the schedule identifier.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#TIMER_TOPIC">TIMER_TOPIC</A></B></CODE>
<BR>
The topic name for the virtual timer topic.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#TRIGGERING_EVENT">TRIGGERING_EVENT</A></B></CODE>
<BR>
The key for the startup argument used to pass the event object that
triggered the schedule to launch the application instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#YEAR">YEAR</A></B></CODE>
<BR>
The name of the <i>year</i> attribute of a virtual timer event.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/osgi/service/application/ApplicationDescriptor.html" title="class in org.osgi.service.application">ApplicationDescriptor</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#getApplicationDescriptor()">getApplicationDescriptor</A></B>()</CODE>
<BR>
Retrieves the ApplicationDescriptor which represents the application and
necessary for launching.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Map</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#getArguments()">getArguments</A></B>()</CODE>
<BR>
Queries the startup arguments specified when the application was
scheduled.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#getEventFilter()">getEventFilter</A></B>()</CODE>
<BR>
Queries the event filter for the triggering event.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#getScheduleId()">getScheduleId</A></B>()</CODE>
<BR>
Returns the identifier of this schedule.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#getTopic()">getTopic</A></B>()</CODE>
<BR>
Queries the topic of the triggering event.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#isRecurring()">isRecurring</A></B>()</CODE>
<BR>
Queries if the schedule is recurring.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/application/ScheduledApplication.html#remove()">remove</A></B>()</CODE>
<BR>
Cancels this schedule of the application.</TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="APPLICATION_PID"><!-- --></A><H3>
APPLICATION_PID</H3>
<PRE>
static final java.lang.String <B>APPLICATION_PID</B></PRE>
<DL>
<DD>The property key for the identifier of the application being scheduled.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ScheduledApplication.APPLICATION_PID">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SCHEDULE_ID"><!-- --></A><H3>
SCHEDULE_ID</H3>
<PRE>
static final java.lang.String <B>SCHEDULE_ID</B></PRE>
<DL>
<DD>The property key for the schedule identifier. The identifier is unique
within the scope of the application being scheduled.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ScheduledApplication.SCHEDULE_ID">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="TRIGGERING_EVENT"><!-- --></A><H3>
TRIGGERING_EVENT</H3>
<PRE>
static final java.lang.String <B>TRIGGERING_EVENT</B></PRE>
<DL>
<DD>The key for the startup argument used to pass the event object that
triggered the schedule to launch the application instance.
The event is passed in a <CODE>GuardedObject</CODE>
protected by the corresponding
<A HREF="../../../../org/osgi/service/event/TopicPermission.html" title="class in org.osgi.service.event"><CODE>TopicPermission</CODE></A>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ScheduledApplication.TRIGGERING_EVENT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="TIMER_TOPIC"><!-- --></A><H3>
TIMER_TOPIC</H3>
<PRE>
static final java.lang.String <B>TIMER_TOPIC</B></PRE>
<DL>
<DD>The topic name for the virtual timer topic. Time based schedules
should be created using this topic.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ScheduledApplication.TIMER_TOPIC">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="YEAR"><!-- --></A><H3>
YEAR</H3>
<PRE>
static final java.lang.String <B>YEAR</B></PRE>
<DL>
<DD>The name of the <i>year</i> attribute of a virtual timer event. The value is
defined by <CODE>Calendar.YEAR</CODE>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ScheduledApplication.YEAR">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MONTH"><!-- --></A><H3>
MONTH</H3>
<PRE>
static final java.lang.String <B>MONTH</B></PRE>
<DL>
<DD>The name of the <i>month</i> attribute of a virtual timer event. The value is
defined by <CODE>Calendar.MONTH</CODE>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ScheduledApplication.MONTH">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DAY_OF_MONTH"><!-- --></A><H3>
DAY_OF_MONTH</H3>
<PRE>
static final java.lang.String <B>DAY_OF_MONTH</B></PRE>
<DL>
<DD>The name of the <i>day of month</i> attribute of a virtual timer event. The value is
defined by <CODE>Calendar.DAY_OF_MONTH</CODE>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ScheduledApplication.DAY_OF_MONTH">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DAY_OF_WEEK"><!-- --></A><H3>
DAY_OF_WEEK</H3>
<PRE>
static final java.lang.String <B>DAY_OF_WEEK</B></PRE>
<DL>
<DD>The name of the <i>day of week</i> attribute of a virtual timer event. The value is
defined by <CODE>Calendar.DAY_OF_WEEK</CODE>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ScheduledApplication.DAY_OF_WEEK">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="HOUR_OF_DAY"><!-- --></A><H3>
HOUR_OF_DAY</H3>
<PRE>
static final java.lang.String <B>HOUR_OF_DAY</B></PRE>
<DL>
<DD>The name of the <i>hour of day</i> attribute of a virtual timer event. The value is
defined by <CODE>Calendar.HOUR_OF_DAY</CODE>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ScheduledApplication.HOUR_OF_DAY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MINUTE"><!-- --></A><H3>
MINUTE</H3>
<PRE>
static final java.lang.String <B>MINUTE</B></PRE>
<DL>
<DD>The name of the <i>minute</i> attribute of a virtual timer event. The value is
defined by <CODE>Calendar.MINUTE</CODE>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.application.ScheduledApplication.MINUTE">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getScheduleId()"><!-- --></A><H3>
getScheduleId</H3>
<PRE>
java.lang.String <B>getScheduleId</B>()</PRE>
<DL>
<DD>Returns the identifier of this schedule. The identifier is unique within
the scope of the application that the schedule is related to.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the identifier of this schedule</DL>
</DD>
</DL>
<HR>
<A NAME="getTopic()"><!-- --></A><H3>
getTopic</H3>
<PRE>
java.lang.String <B>getTopic</B>()</PRE>
<DL>
<DD>Queries the topic of the triggering event. The topic may contain a
trailing asterisk as wildcard.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the topic of the triggering event
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if the scheduled application service is unregistered</DL>
</DD>
</DL>
<HR>
<A NAME="getEventFilter()"><!-- --></A><H3>
getEventFilter</H3>
<PRE>
java.lang.String <B>getEventFilter</B>()</PRE>
<DL>
<DD>Queries the event filter for the triggering event.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the event filter for triggering event
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if the scheduled application service is unregistered</DL>
</DD>
</DL>
<HR>
<A NAME="isRecurring()"><!-- --></A><H3>
isRecurring</H3>
<PRE>
boolean <B>isRecurring</B>()</PRE>
<DL>
<DD>Queries if the schedule is recurring.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if the schedule is recurring, otherwise returns false
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if the scheduled application service is unregistered</DL>
</DD>
</DL>
<HR>
<A NAME="getApplicationDescriptor()"><!-- --></A><H3>
getApplicationDescriptor</H3>
<PRE>
<A HREF="../../../../org/osgi/service/application/ApplicationDescriptor.html" title="class in org.osgi.service.application">ApplicationDescriptor</A> <B>getApplicationDescriptor</B>()</PRE>
<DL>
<DD>Retrieves the ApplicationDescriptor which represents the application and
necessary for launching.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the application descriptor that
represents the scheduled application
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if the scheduled application service is unregistered</DL>
</DD>
</DL>
<HR>
<A NAME="getArguments()"><!-- --></A><H3>
getArguments</H3>
<PRE>
java.util.Map <B>getArguments</B>()</PRE>
<DL>
<DD>Queries the startup arguments specified when the application was
scheduled. The method returns a copy of the arguments, it is not possible
to modify the arguments after scheduling.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the startup arguments of the scheduled application. It may be
null if null argument was specified.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if the scheduled application service is unregistered</DL>
</DD>
</DL>
<HR>
<A NAME="remove()"><!-- --></A><H3>
remove</H3>
<PRE>
void <B>remove</B>()</PRE>
<DL>
<DD>Cancels this schedule of the application.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.lang.SecurityException</CODE> - if the caller doesn't have "schedule"
ApplicationAdminPermission for the scheduled application.
<DD><CODE>java.lang.IllegalStateException</CODE> - if the scheduled application service is unregistered</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/osgi/service/application/ApplicationHandle.html" title="class in org.osgi.service.application"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/application/ScheduledApplication.html" target="_top"><B>FRAMES</B></A>
<A HREF="ScheduledApplication.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|