RIM Device Java Library: Class CodeModuleGroup

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

SHOW Signed

net.rim.device.api.system
Class CodeModuleGroup

java.lang.Object
  |
  +--net.rim.device.api.system.CodeModuleGroup

public final class CodeModuleGroup
extends Object

Code module group.

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:: JDE 4.0.2

Field Summary

static int FLAG_DEPENDENCY
          The group is a child of another group.

static int FLAG_HIDDEN
          The group should be hidden from view.

static int FLAG_REQUIRED
          The group is required, and should not be deleted.

Constructor Summary

CodeModuleGroup(String groupName)
          Creates a new CodeModuleGroup with provided name.

Method Summary

void addDependency(String groupName)
          Adds named dependency to this code module group.

void addModule(String moduleName)
          Adds named module to this code module group.

boolean containsDependency(String groupName)
          Determines if this code module group depends on named group.

boolean containsModule(String moduleName)
          Determines if this code module group contains named code module.

void delete()
          Deletes this code module group.

boolean equals(Object o)
          Indicates whether some other object is "equal to" this one.

String getCopyright()
          Retrieves this code module group's copyright.

Enumeration getDependencies()
          Retrieves list of dependencies for this code module group.

String getDescription()
          Retrieves this code module group's description.

int getFlags()
          Retrieves this code module group's flag mask.

String getFriendlyName()
          Retrieves this code module group's friendly name.

int getHandle()
          Retrieves the handle for this code module group.

Enumeration getModules()
          Retrieves the list of this code module group's modules.

String getName()
          Retrieves this code module group's name.

String getProperty(String name)
          Retrieves value for this code module group's named property.

String getVendor()
          Retrieves this code module group's vendor.

String getVersion()
          Retrieves this code module group's version.

static CodeModuleGroup load(String groupName)
          Loads code module group by name.

static CodeModuleGroup[] loadAll()
          Loads all known code module groups.

void setCopyright(String copyright)
          Sets this code module group's copyright.

void setDescription(String description)
          Sets this code module group's description.

void setFlag(int flag, boolean value)
          Sets (or clears) named flag in this code module group's flag mask.

void setFriendlyName(String friendlyName)
          Sets this code module group's friendly name.

void setProperty(String name, String value)
          Sets property value for this code module group.

void setVendor(String vendor)
          Sets this code module group's vendor.

void setVersion(String version)
          Sets this code module group's version.

boolean store()
          Stores this code module group.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLAG_REQUIRED

public static final int FLAG_REQUIRED

The group is required, and should not be deleted.

Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

FLAG_HIDDEN

public static final int FLAG_HIDDEN

The group should be hidden from view.

Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

FLAG_DEPENDENCY

public static final int FLAG_DEPENDENCY

The group is a child of another group.

Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Constructor Detail

CodeModuleGroup

public CodeModuleGroup(String groupName)

Creates a new CodeModuleGroup with provided name.

Parameters:: groupName - Name for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Method Detail

getName

public String getName()

Retrieves this code module group's name.

Returns:: Name for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getModules

public Enumeration getModules()

Retrieves the list of this code module group's modules.

Returns:: Enumeration of tall the modules in this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getHandle

public int getHandle()

Retrieves the handle for this code module group.

Returns:: Handle for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

containsModule

public boolean containsModule(String moduleName)

Determines if this code module group contains named code module.

Parameters:: moduleName - Name of module to look for.
Returns:: True if named module appears in this group; otherwise, false.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

addModule

public void addModule(String moduleName)

Adds named module to this code module group.

Parameters:: moduleName - Name of module to add to this gorup.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getDependencies

public Enumeration getDependencies()

Retrieves list of dependencies for this code module group.

Returns:: Enumeration of all dependencies for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

addDependency

public void addDependency(String groupName)

Adds named dependency to this code module group.

Parameters:: groupName - Name of group upon which this group should depend.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

containsDependency

public boolean containsDependency(String groupName)

Determines if this code module group depends on named group.

Parameters:: groupName - Name of group to test for dependency.
Returns:: True if this group depends on named group; otherwise, false.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getFlags

public int getFlags()

Retrieves this code module group's flag mask.

Returns:: Combine set of flags for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setFlag

public void setFlag(int flag,
                    boolean value)

Sets (or clears) named flag in this code module group's flag mask.

Parameters:: flag - Flag to set or clear.; value - True to set flag; false to clear flag.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getFriendlyName

public String getFriendlyName()

Retrieves this code module group's friendly name.

Returns:: Friendly name for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setFriendlyName

public void setFriendlyName(String friendlyName)

Sets this code module group's friendly name.

Parameters:: friendlyName - Friendly name for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getDescription

public String getDescription()

Retrieves this code module group's description.

Returns:: Description for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setDescription

public void setDescription(String description)

Sets this code module group's description.

Parameters:: description - Description for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getVersion

public String getVersion()

Retrieves this code module group's version.

Returns:: Version string for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setVersion

public void setVersion(String version)

Sets this code module group's version.

Parameters:: version - Version string for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getVendor

public String getVendor()

Retrieves this code module group's vendor.

Returns:: Vendor string for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setVendor

public void setVendor(String vendor)

Sets this code module group's vendor.

Parameters:: vendor - Vendor string for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getCopyright

public String getCopyright()

Retrieves this code module group's copyright.

Returns:: Copyright string for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setCopyright

public void setCopyright(String copyright)

Sets this code module group's copyright.

Parameters:: copyright - Copyright string for this group.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getProperty

public String getProperty(String name)

Retrieves value for this code module group's named property.

Parameters:: name - Name of property to examine.
Returns:: Value of named property, or null if no such property.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setProperty

public void setProperty(String name,
                        String value)

Sets property value for this code module group.

Parameters:: name - Name of property to set.; value - Value for named property.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

load

public static CodeModuleGroup load(String groupName)

Loads code module group by name.

Use this method to load a named code module group into a CodeModuleGroup object and then retrieve the object.

Parameters:: groupName - Name of group to load.
Returns:: Named group; or, null if no such named group, or named group is not loadable.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

loadAll

public static CodeModuleGroup[] loadAll()

Loads all known code module groups.

Use this method to retrieve an array of all known, loadable code module groups loaded into CodeModuleGroup objects.

Returns:: Array of all known groups; or, null if no list of groups available, or list of available groups has no members.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

store

public boolean store()

Stores this code module group.

Returns:: True if this group successfully stored itself; otherwise, false.
Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

delete

public void delete()

Deletes this code module group.

Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

equals

public boolean equals(Object o)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

It is reflexive: for any reference value x, x.equals(x) should return true.
It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified.
For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Overrides:: equals in class Object

Since:: JDE 4.0.2

Category:: Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.