Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

net.rim.device.api.itpolicy
Class ITPolicy

java.lang.Object
  extended by net.rim.device.api.itpolicy.ITPolicy

public final class ITPolicy
extends Object

Provides access to the IT policy database.

IT Policy is used by BlackBerry system administrators to govern the desktop and handheld settings of individual BlackBerry handheld users. IT policies enable system administrators to customize the features that are common to all BlackBerry handheld users on a given BlackBerry Enterprise Server, such as password details and convenience settings like mail forwarding options and browser settings.

IT policies provide an efficient method for managing many different users simultaneously.

Since:
BlackBerry API 3.6.0

Field Summary
static long GUID_IT_POLICY_CHANGED
          Deprecated. Use ITPolicyChangedListener.policyChanged(java.lang.String, boolean). This event will only go to non-RIM applications
static long GUID_IT_POLICY_CHANGED_LOCKED_HANDHELD
          Deprecated. Use . This event will only go to non-RIM applications
static long GUID_PASSWORD_SET_BY_ITADMIN
          Deprecated. Use ITPolicyInfoListener.passwordSetByAdmin(). This event will only go to non-RIM applications
static int PUBLIC_KEY_TAG
          Represents the public key sub tag (for use with ITPOLICY_VERIFICATION_KEYS tag)
static int SIGNATURE_KEY_TAG
          Represents the signature key sub tag (for use with ITPOLICY_SIGNATURE_KEYS tag)
static int TERNARY_FALSE
          Represents the ternary false value.
static int TERNARY_PROMPT
          Represents the ternary prompt value.
static int TERNARY_TRUE
          Represents the ternary true value.
 
Method Summary
static void addListener(ITPolicyListener listener)
          Add a listener to process IT policy events.
static void addListener(Application application, ITPolicyListener listener)
          Add a listener to process IT policy events.
static boolean getBoolean(int id, boolean defaultValue)
          Retrieve a boolean valued field from the IT policy database.
static boolean getBoolean(int group, int id, boolean defaultValue)
          Retrieve a boolean valued field from the IT policy database for a given group.
static boolean getBoolean(String name, boolean defaultValue)
          Retrieve a boolean valued field from the IT policy database given the name of the field.
static byte getByte(int id, byte defaultValue)
          Retrieve a byte valued field from the IT policy database.
static byte getByte(int group, int id, byte defaultValue)
          Retrieve a byte valued field from the IT policy database for a given group.
static byte getByte(String name)
          Retrieve a byte valued field from the IT policy database given the name of the field.
static byte[] getByteArray(int id)
          Retrieve a byte array valued field from the IT policy database.
static byte[] getByteArray(int group, int id)
          Retrieve a byte array valued field from the IT policy database for a given group.
static byte[] getByteArray(String name)
          Retrieve a byte array valued field from the IT policy database given the name of the field.
static int getInteger(int id, int defaultValue)
          Retrieve an integer valued field from the IT policy database.
static int getInteger(int group, int id, int defaultValue)
          Retrieve an integer valued field from the IT policy database for a given group.
static int getInteger(String name, int defaultValue)
          Retrieve an integer valued field from the IT policy database given the name of the field.
static String getString(int id)
          Retrieve a string valued field from the IT policy database.
static String getString(int group, int id)
          Retrieve a string valued field from the IT policy database for a given group.
static String getString(String name)
          Retrieve a string valued field from the IT policy database given the name of the field.
static void removeListener(ITPolicyListener listener)
          Remove a listener from the calling application's list of listeners.
static void removeListener(Application application, ITPolicyListener listener)
          Remove a listener from the calling application's list of listeners.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Field Detail

GUID_IT_POLICY_CHANGED

public static final long GUID_IT_POLICY_CHANGED
Deprecated. Use ITPolicyChangedListener.policyChanged(java.lang.String, boolean). This event will only go to non-RIM applications
The GUID for the global event sent when the IT Policy changes.

See Also:
Constant Field Values
Since:
BlackBerry API 3.6.0

GUID_IT_POLICY_CHANGED_LOCKED_HANDHELD

public static final long GUID_IT_POLICY_CHANGED_LOCKED_HANDHELD
Deprecated. Use . This event will only go to non-RIM applications
The GUID for the global event sent when the IT Policy changes and handheld locking is required

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.0

GUID_PASSWORD_SET_BY_ITADMIN

public static final long GUID_PASSWORD_SET_BY_ITADMIN
Deprecated. Use ITPolicyInfoListener.passwordSetByAdmin(). This event will only go to non-RIM applications
The GUID for the global event sent when the password is changed by the BES administrator.

See Also:
Constant Field Values
Since:
BlackBerry API 4.3.0

TERNARY_TRUE

public static final int TERNARY_TRUE
Represents the ternary true value.

See Also:
Constant Field Values
Since:
BlackBerry API 3.6.0

TERNARY_FALSE

public static final int TERNARY_FALSE
Represents the ternary false value.

See Also:
Constant Field Values
Since:
BlackBerry API 3.6.0

TERNARY_PROMPT

public static final int TERNARY_PROMPT
Represents the ternary prompt value.

See Also:
Constant Field Values
Since:
BlackBerry API 3.6.0

PUBLIC_KEY_TAG

public static final int PUBLIC_KEY_TAG
Represents the public key sub tag (for use with ITPOLICY_VERIFICATION_KEYS tag)

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.2

SIGNATURE_KEY_TAG

public static final int SIGNATURE_KEY_TAG
Represents the signature key sub tag (for use with ITPOLICY_SIGNATURE_KEYS tag)

See Also:
Constant Field Values
Since:
BlackBerry API 4.0.2


Method Detail

getString

public static String getString(String name)
Retrieve a string valued field from the IT policy database given the name of the field.

Parameters:
name - the name of the field
Returns:
the field value or null if no entry is found
Since:
BlackBerry API 3.6.0

getByteArray

public static byte[] getByteArray(String name)
Retrieve a byte array valued field from the IT policy database given the name of the field.

Parameters:
name - the name of the field
Returns:
the field value or null if no entry is found
Since:
BlackBerry API 3.6.0

getByte

public static byte getByte(String name)
Retrieve a byte valued field from the IT policy database given the name of the field.

Parameters:
name - the name of the field
Returns:
the field value or a null byte ('\0') if no entry is found
Since:
BlackBerry API 3.6.0

getBoolean

public static boolean getBoolean(String name,
                                 boolean defaultValue)
Retrieve a boolean valued field from the IT policy database given the name of the field.

Parameters:
name - the name of the field
defaultValue - the value to be returned if no entry is found
Returns:
the field value or defaultValue if the field is not found
Since:
BlackBerry API 3.6.0

getInteger

public static int getInteger(String name,
                             int defaultValue)
Retrieve an integer valued field from the IT policy database given the name of the field.

Parameters:
name - the name of the field
defaultValue - the value to be returned if the field is not found
Returns:
the field value or defaultValue if the field is not found
Since:
BlackBerry API 3.6.0

getString

public static String getString(int id)
Retrieve a string valued field from the IT policy database.

Parameters:
id - the field identifier
Returns:
the field value or null if the field is not found
Since:
BlackBerry API 3.6.0

getString

public static String getString(int group,
                               int id)
Retrieve a string valued field from the IT policy database for a given group.

Parameters:
group - the group key
id - the identifier of the field within the group
Returns:
the field value or null if the field is not found
Since:
BlackBerry API 3.6.0

getByteArray

public static byte[] getByteArray(int id)
Retrieve a byte array valued field from the IT policy database.

Parameters:
id - the field identifier
Returns:
the field value or null if the field is not found
Since:
BlackBerry API 3.6.0

getByteArray

public static byte[] getByteArray(int group,
                                  int id)
Retrieve a byte array valued field from the IT policy database for a given group.

Parameters:
group - the group key
id - the identifier of the field within the group
Returns:
the field value or null if the field is not found
Since:
BlackBerry API 3.6.0

getBoolean

public static boolean getBoolean(int id,
                                 boolean defaultValue)
Retrieve a boolean valued field from the IT policy database.

Parameters:
id - the field identifier
defaultValue - the value to be returned if the field is not found
Returns:
the field value or defaultValue if the field is not found
Since:
BlackBerry API 3.6.0

getBoolean

public static boolean getBoolean(int group,
                                 int id,
                                 boolean defaultValue)
Retrieve a boolean valued field from the IT policy database for a given group.

Parameters:
group - the group key
id - the identifier of the field within the group
defaultValue - the value to be returned if the field is not found
Returns:
the field value or defaultValue if the field is not found
Since:
BlackBerry API 3.6.0

getInteger

public static int getInteger(int id,
                             int defaultValue)
Retrieve an integer valued field from the IT policy database.

Parameters:
id - the field identifier
defaultValue - the value to be returned if the field is not found
Returns:
the field value or defaultValue if the field is not found
Since:
BlackBerry API 3.6.0

getInteger

public static int getInteger(int group,
                             int id,
                             int defaultValue)
Retrieve an integer valued field from the IT policy database for a given group.

Parameters:
group - the group key
id - the identifier of the field within the group
defaultValue - the value to be returned if the field is not found
Returns:
the field value or defaultValue if the field is not found
Since:
BlackBerry API 3.6.0

getByte

public static byte getByte(int id,
                           byte defaultValue)
Retrieve a byte valued field from the IT policy database.

Parameters:
id - the field identifier
defaultValue - the value to be returned if the field is not found
Returns:
the field value or defaultValue if the field is not found
Since:
BlackBerry API 3.6.0

getByte

public static byte getByte(int group,
                           int id,
                           byte defaultValue)
Retrieve a byte valued field from the IT policy database for a given group.

Parameters:
group - the group key
id - the identifier of the field within the group
defaultValue - the value to be returned if the field is not found
Returns:
the field value or defaultValue if the field is not found
Since:
BlackBerry API 3.6.0

addListener

public static void addListener(ITPolicyListener listener)
Add a listener to process IT policy events. The listener notifications will be processed by the calling application's event thread.

Parameters:
listener - ITPolicyListener for process termination events
Throws:
NullPointerException - if listener is null
IllegalStateException - if this method is called when there is no Application object in the calling process
Since:
BlackBerry API 5.0.0

addListener

public static void addListener(Application application,
                               ITPolicyListener listener)
Add a listener to process IT policy events. The listener notifications will be processed by the calling application's event thread.

Parameters:
application - the Application whose event thread will process the notifications sent to listener
listener - ITPolicyListener for process termination events.
Throws:
NullPointerException - if listener is null
IllegalStateException - if this method is called when there is no Application object in the calling process
Since:
BlackBerry API 5.0.0

removeListener

public static void removeListener(ITPolicyListener listener)
Remove a listener from the calling application's list of listeners. If listener is null or is not on the calling application's list of listeners, then this method does nothing.

Parameters:
listener - ITPolicyListener for process termination events
Throws:
IllegalStateException - if this method is called when there is no Application object in the calling process
Since:
BlackBerry API 5.0.0

removeListener

public static void removeListener(Application application,
                                  ITPolicyListener listener)
Remove a listener from the calling application's list of listeners. If listener is null or is not on the calling application's list of listeners, then this method does nothing.

Parameters:
application - the Application whose event thread will no longer process the notifications sent to listener
listener - the ITPolicyListener for process termination events
Throws:
IllegalStateException - if this method is called when there is no Application object in the calling process
Since:
BlackBerry API 5.0.0



Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal