File	Doc	Category	Size	Date	Package
MIDletSuite.java	API Doc	phoneME MR2 API (J2ME)	9618	Wed May 02 18:00:06 BST 2007	com.sun.midp.midlet

MIDletSuite

Fields Summary
public static final int	UNUSED_SUITE_ID Suite ID that is never used.
public static final int	INTERNAL_SUITE_ID Suite ID used for internal midlet suites.
public static final String	JAR_MANIFEST Filename of Manifest inside the application archive.
public static final String	DATA_SIZE_PROP MIDlet property for the size of the application data.
public static final String	JAR_SIZE_PROP MIDlet property for the size of the application archive.
public static final String	JAR_URL_PROP MIDlet property for the application archive URL.
public static final String	SUITE_NAME_PROP MIDlet property for the suite name.
public static final String	VENDOR_PROP MIDlet property for the suite vendor.
public static final String	VERSION_PROP MIDlet property for the suite version.
public static final String	DESC_PROP MIDlet property for the suite description.
public static final String	CONFIGURATION_PROP MIDlet property for the microedition configuration.
public static final String	PROFILE_PROP MIDlet property for the profile.
public static final String	RUNTIME_EXEC_ENV_PROP MIDlet Runtime Execution Environment (MIDP.CLDC by default)
public static final String	RUNTIME_EXEC_ENV_DEFAULT Default value for the Runtime-Execution-Environment property
public static final String	PERMISSIONS_PROP MIDlet property for the required permissions.
public static final String	PERMISSIONS_OPT_PROP MIDlet property for the optional permissions.

Constructors Summary

Methods Summary
public void	checkForPermission(int permission, java.lang.String resource) Check for permission and throw an exception if not allowed. May block to ask the user a question. param permission ID of the permission to check for, the ID must be from {@link com.sun.midp.security.Permissions} param resource string to insert into the question, can be null if no %2 in the question exception SecurityException if the permission is not allowed by this token exception InterruptedException if another thread interrupts the calling thread while this method is waiting to preempt the display.
public void	checkForPermission(int permission, java.lang.String resource, java.lang.String extraValue) Checks for permission and throw an exception if not allowed. May block to ask the user a question. param permission ID of the permission to check for, the ID must be from {@link com.sun.midp.security.Permissions} param resource string to insert into the question, can be null if no %2 in the question param extraValue string to insert into the question, can be null if no %3 in the question exception SecurityException if the permission is not allowed by this token exception InterruptedException if another thread interrupts the calling thread while this method is waiting to preempt the display.
public void	checkIfPermissionAllowed(int permission) Check to see the suite has the ALLOW level for specific permission. This is used for by internal APIs that only provide access to trusted system applications. Only trust this method if the object has been obtained from the Scheduler of the suite. param permission permission ID from {@link com.sun.midp.security.Permissions} exception SecurityException if the suite is not allowed to perform the specified action.
public int	checkPermission(java.lang.String permission) Get the status of the specified permission. If no API on the device defines the specific permission requested then it must be reported as denied. If the status of the permission is not known because it might require a user interaction then it should be reported as unknown. param permission to check if denied, allowed, or unknown. return 0 if the permission is denied; 1 if the permission is allowed; -1 if the status is unknown
public void	close() Close the opened MIDletSuite
public int	getID() Gets the unique ID of the suite. return suite ID
public java.lang.String	getMIDletName(java.lang.String className) Get the name of a MIDlet to display to the user. param className classname of a MIDlet in the suite return name to display to the user
public byte[]	getPermissions() Gets list of permissions for this suite. return array of permissions from {@link Permissions}
public java.lang.String	getProperty(java.lang.String key) Get a property of the suite. A property is an attribute from either the application descriptor or JAR Manifest. param key the name of the property return A string with the value of the property. null is returned if no value is available for the key.
public byte	getPushInterruptSetting() Gets push setting for interrupting other MIDlets. Reuses the Permissions. return push setting for interrupting MIDlets the value will be permission level from {@link Permissions}
public int	getPushOptions() Gets push options for this suite. return push options are defined in {@link PushRegistryImpl}
public boolean	isEnabled() Determine if the a MIDlet from this suite can be run. Note that disable suites can still have their settings changed and their install info displayed. return true if suite is enabled, false otherwise
public boolean	isRegistered(java.lang.String midletClassName) Indicates if the named MIDlet is registered in the suite with MIDlet-<n> record in the manifest or application descriptor. param midletClassName class name of the MIDlet to be checked return true if the MIDlet is registered
public boolean	isTrusted() Indicates if this suite is trusted. (not to be confused with a domain named "trusted", this is used for extra checks beyond permission checking) return true if the suite is trusted false if not
public boolean	isVerified() Check whether the suite classes are preverified and the suite content hasn't been changed since installation return true if no more verification needed, false otherwise
public boolean	permissionToInterrupt(java.lang.String connection) Ask the user want to interrupt the current MIDlet with a new MIDlet that has received network data. param connection connection to place in the permission question or null for alarm return true if the use wants interrupt the current MIDlet, else false
public void	setTempProperty(com.sun.midp.security.SecurityToken token, java.lang.String key, java.lang.String value) Replace or add a property to the suite for this run only. param token token with the AMS permission set to allowed, can be null to use the suite's permission param key the name of the property param value the value of the property exception SecurityException if the caller's token does not have internal AMS permission