/usr/share/doc/libosgi-compendium-java/api/org/osgi/util/mobile/UserPromptCondition.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 | <!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 Mon Nov 21 22:05:28 UTC 2011 -->
<TITLE>
UserPromptCondition
</TITLE>
<META NAME="date" CONTENT="2011-11-21">
<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="UserPromptCondition";
}
}
</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">
PREV CLASS
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/util/mobile/UserPromptCondition.html" target="_top"><B>FRAMES</B></A>
<A HREF="UserPromptCondition.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | 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.util.mobile</FONT>
<BR>
Class UserPromptCondition</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.osgi.util.mobile.UserPromptCondition</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>org.osgi.service.condpermadmin.Condition</DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>UserPromptCondition</B><DT>extends java.lang.Object<DT>implements org.osgi.service.condpermadmin.Condition</DL>
</PRE>
<P>
Class representing a user prompt condition. Instances of this class hold two
values: a prompt string that is to be displayed to the user and the
permission level string according to MIDP2.0 (oneshot, session, blanket).
<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>
</TABLE>
<A NAME="fields_inherited_from_class_org.osgi.service.condpermadmin.Condition"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from interface org.osgi.service.condpermadmin.Condition</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>FALSE, TRUE</CODE></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>static org.osgi.service.condpermadmin.Condition</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/util/mobile/UserPromptCondition.html#getCondition(org.osgi.framework.Bundle, org.osgi.service.condpermadmin.ConditionInfo)">getCondition</A></B>(org.osgi.framework.Bundle bundle,
org.osgi.service.condpermadmin.ConditionInfo conditionInfo)</CODE>
<BR>
Returns a UserPromptCondition object with the given prompt string and permission
level.</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/util/mobile/UserPromptCondition.html#isMutable()">isMutable</A></B>()</CODE>
<BR>
Checks whether the condition may change during the lifetime of the UserPromptCondition object.</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/util/mobile/UserPromptCondition.html#isPostponed()">isPostponed</A></B>()</CODE>
<BR>
Checks if the <A HREF="../../../../org/osgi/util/mobile/UserPromptCondition.html#isSatisfied()"><CODE>isSatisfied()</CODE></A> method needs to prompt the user, thus cannot
give results instantly.</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/util/mobile/UserPromptCondition.html#isSatisfied()">isSatisfied</A></B>()</CODE>
<BR>
Displays the prompt string to
the user and returns true if the user accepts.</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/util/mobile/UserPromptCondition.html#isSatisfied(org.osgi.service.condpermadmin.Condition[], java.util.Dictionary)">isSatisfied</A></B>(org.osgi.service.condpermadmin.Condition[] conds,
java.util.Dictionary context)</CODE>
<BR>
Checks an array of UserPrompt conditions.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ 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="getCondition(org.osgi.framework.Bundle, org.osgi.service.condpermadmin.ConditionInfo)"><!-- --></A><H3>
getCondition</H3>
<PRE>
public static org.osgi.service.condpermadmin.Condition <B>getCondition</B>(org.osgi.framework.Bundle bundle,
org.osgi.service.condpermadmin.ConditionInfo conditionInfo)</PRE>
<DL>
<DD>Returns a UserPromptCondition object with the given prompt string and permission
level. The user should be given choice as to what level of permission is
given. Thus, the lifetime of the permission is controlled by the user.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>bundle</CODE> - the bundle to ask about.<DD><CODE>conditionInfo</CODE> - the conditionInfo containing the construction information. Its
<CODE>ConditionInfo.getArgs()</CODE> method should return a String array with 4
strings in it:
<ol start="0">
<li>the possible permission levels. This is a comma-separated list that can contain
following strings: ONESHOT SESSION BLANKET. The order is not important. This
parameter is case-insensitive.
</li>
<li>the default permission level, one chosen from the possible permission levels. If
it is an empty string, then there is no default. This parameter
is case-insensitive.</li>
<li>the message catalog base name. It will be loaded by a <CODE>ResourceBundle</CODE>,
or equivalent
from an exporting OSGi Bundle. Thus, if the catalogName is "com.provider.messages.userprompt",
then there should be an OSGi Bundle exporting the "com.provider.messages" package, and inside
it files like "userprompt_en_US.properties".</li>
<li>textual description of the condition, to be displayed to the user. If
it starts with a '%' sign, then the message is looked up from the catalog specified previously.
The key is the rest of the string after the '%' sign.</li>
</ol>
<DT><B>Returns:</B><DD>The requested UserPromptCondition.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the parameters are malformed.
<DD><CODE>java.lang.NullPointerException</CODE> - if one of the parameters is <code>null</code>.</DL>
</DD>
</DL>
<HR>
<A NAME="isPostponed()"><!-- --></A><H3>
isPostponed</H3>
<PRE>
public boolean <B>isPostponed</B>()</PRE>
<DL>
<DD>Checks if the <A HREF="../../../../org/osgi/util/mobile/UserPromptCondition.html#isSatisfied()"><CODE>isSatisfied()</CODE></A> method needs to prompt the user, thus cannot
give results instantly.
This depends on the permission level given in
<A HREF="../../../../org/osgi/util/mobile/UserPromptCondition.html#getCondition(org.osgi.framework.Bundle, org.osgi.service.condpermadmin.ConditionInfo)"><CODE>getCondition(Bundle, ConditionInfo)</CODE></A>.
<ul>
<li>ONESHOT - isPostponed always returns true. The user is prompted for question every time.</li>
<li>SESSION - isPostponed returns true until the user decides either yes or no for the current session.</li>
<li>BLANKET - isPostponed returns true until the user decides either always or never.</li>
</ul>
Regardless of the session level, the user is always given the option to reject the prompt
permanently, as if BLANKET/never was chosen. In this case, the question is not postponed
anymore, and <A HREF="../../../../org/osgi/util/mobile/UserPromptCondition.html#isSatisfied()"><CODE>isSatisfied()</CODE></A> returns false.<br/>
If the system supports an separately accessible permission management GUI,
that may reset the condition
to its initial state.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isPostponed</CODE> in interface <CODE>org.osgi.service.condpermadmin.Condition</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>True, if user interaction is needed.</DL>
</DD>
</DL>
<HR>
<A NAME="isMutable()"><!-- --></A><H3>
isMutable</H3>
<PRE>
public boolean <B>isMutable</B>()</PRE>
<DL>
<DD>Checks whether the condition may change during the lifetime of the UserPromptCondition object.
This depends on the permission level given in
<A HREF="../../../../org/osgi/util/mobile/UserPromptCondition.html#getCondition(org.osgi.framework.Bundle, org.osgi.service.condpermadmin.ConditionInfo)"><CODE>getCondition(Bundle, ConditionInfo)</CODE></A>.
<ul>
<li>ONESHOT - true</li>
<li>SESSION - true, if the application model's session lifetime is
shorter than the UserPromptCondition object lifetime</li>
<li>BLANKET - false</li>
</ul>
If the system supports separately accessible permission management GUI,
then this function may also return true for SESSION and BLANKET.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isMutable</CODE> in interface <CODE>org.osgi.service.condpermadmin.Condition</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>True, if the condition can change.</DL>
</DD>
</DL>
<HR>
<A NAME="isSatisfied()"><!-- --></A><H3>
isSatisfied</H3>
<PRE>
public boolean <B>isSatisfied</B>()</PRE>
<DL>
<DD>Displays the prompt string to
the user and returns true if the user accepts. Depending on the
amount of levels the condition is assigned to, the prompt may have
multiple accept buttons and one of them can be selected by default (see
default level parameter at <A HREF="../../../../org/osgi/util/mobile/UserPromptCondition.html#getCondition(org.osgi.framework.Bundle, org.osgi.service.condpermadmin.ConditionInfo)"><CODE>getCondition(Bundle, ConditionInfo)</CODE></A>).
It must always be possible for the user
to stop further prompting of this question, even with ONESHOT and SESSION levels.
In case of BLANKET
and SESSION levels, it is possible that the user has already answered the question,
in this case there will be no prompting, but immediate return with the previous answer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isSatisfied</CODE> in interface <CODE>org.osgi.service.condpermadmin.Condition</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>True if the user accepts the prompt (or accepts any prompt in
case there are multiple permission levels).</DL>
</DD>
</DL>
<HR>
<A NAME="isSatisfied(org.osgi.service.condpermadmin.Condition[], java.util.Dictionary)"><!-- --></A><H3>
isSatisfied</H3>
<PRE>
public boolean <B>isSatisfied</B>(org.osgi.service.condpermadmin.Condition[] conds,
java.util.Dictionary context)</PRE>
<DL>
<DD>Checks an array of UserPrompt conditions.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>isSatisfied</CODE> in interface <CODE>org.osgi.service.condpermadmin.Condition</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>conds</CODE> - The array containing the UserPrompt conditions to evaluate.<DD><CODE>context</CODE> - Storage area for evaluation. The <CODE>ConditionalPermissionAdmin</CODE>
may evaluate a condition several times for one permission check, so this context
will be used to store results of ONESHOT questions. This way asking the same question
twice in a row can be avoided. If context is null, temporary results will not be stored.
<DT><B>Returns:</B><DD>True, if all conditions are satisfied.
<DT><B>Throws:</B>
<DD><CODE>java.lang.NullPointerException</CODE> - if conds is null.</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">
PREV CLASS
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/util/mobile/UserPromptCondition.html" target="_top"><B>FRAMES</B></A>
<A HREF="UserPromptCondition.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|