com.symbol.emdk

Class ProfileManager

java.lang.Object

com.symbol.emdk.EMDKBase

com.symbol.emdk.ProfileManager

public class ProfileManager
extends EMDKBase

This class handles all the profile related functions.

 
 	Example Usage:
 	private ProfileManager profileManager = (ProfileManager) EMDKManager.getInstance(EMDKManager.FEATURE_TYPE.PROFILE);
 

When using ProfileManager consider the followings:

1. If the profile name is given in the extraData (third argument of processProfile API) and if it does not match the profile name (first argument of processProfile API), the profile will NOT be modified.
2. The profile name provided in extraData (third argument of processProfile API) is ignored if a profile segment is present in criteria (first argument of processProfile API).
3. The profile applied by passing extraData in Profile Manager's process profile method is stored in the memory until the Profile Manager is released or process profile method is called with PROFILE_FLAG.RESET.
4. To determine if the processProfile API is successful, check the “statusCode." If the statusCode is set to “CHECK_XML," traverse through the response XML (embedded in EMDKResults) to obtain the error. The EMDK samples demonstrate the manipulation of response XML for errors.
5. In some cases the EMDKResults.getExtendedStatusMessage() might not provide correct status information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProfileManager.DataListener An interface for notifying client applications to notify processProfileAsync result.
static class	ProfileManager.PROFILE_FLAG All the possible actions for processProfile(String, PROFILE_FLAG, Document) and processProfile(String, PROFILE_FLAG, String[])}is enumerated here.
class	ProfileManager.ResultData This class provides the Status detail of processProfileAsync method.

Method Summary

Modifier and Type	Method and Description
void	addDataListener(ProfileManager.DataListener listener) The client can register to get data notification via callbacks.
static java.lang.String	CreateNameValuePair(java.lang.String emdkName, java.lang.String paramName, java.lang.String paramValue) This function creates a name value pair string according to the Name-Value pair request.
boolean	isPreviousRequestPending() This method tells whether the previous process profile request is pending or not.
EMDKResults	processProfile(java.lang.String profileName, ProfileManager.PROFILE_FLAG profileFlag, org.w3c.dom.Document extraData) Processes the given profile based on the data provided and the flag and return status of the action.
EMDKResults	processProfile(java.lang.String profileName, ProfileManager.PROFILE_FLAG profileFlag, ProfileConfig extraData) Deprecated.
EMDKResults	processProfile(java.lang.String profileName, ProfileManager.PROFILE_FLAG profileFlag, java.lang.String[] extraData) Processes the given profile based on the data provided and the flag and return status of the action.
EMDKResults	processProfileAsync(java.lang.String profileName, ProfileManager.PROFILE_FLAG profileFlag, org.w3c.dom.Document extraData) Processes the given profile based on the data provided and the flag and return status of the request.
EMDKResults	processProfileAsync(java.lang.String profileName, ProfileManager.PROFILE_FLAG profileFlag, ProfileConfig extraData) Deprecated.
EMDKResults	processProfileAsync(java.lang.String profileName, ProfileManager.PROFILE_FLAG profileFlag, java.lang.String[] extraData) Processes the given profile based on the data provided and the flag and return status of the request.
void	removeDataListener(ProfileManager.DataListener listener) The client can un-register to get data notification via callbacks.

Methods inherited from class com.symbol.emdk.EMDKBase

getType

Methods inherited from class java.lang.Object

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

Method Detail

isPreviousRequestPending

public boolean isPreviousRequestPending()

This method tells whether the previous process profile request is pending or not. If the previous request is pending, you can't submit the next request till the current request completes and calling the process profile method will return error.

Returns:

Returns whether the previous process profile request is pending or not.

CreateNameValuePair

public static java.lang.String CreateNameValuePair(java.lang.String emdkName,
                                                   java.lang.String paramName,
                                                   java.lang.String paramValue)

This function creates a name value pair string according to the Name-Value pair request. The return string is compatible with com.symbol.emdk.ProfileManager. processProfile(String profileName, PROFILE_FLAG profileFlag, String[] extraData) function's extraData array element. The InvalidParameterException will get thrown on following scenarios: If emdkName is null or blank If paramName is null or blank If paramValue is null The period (.) and equal (=) characters can not be used in the emdkName and paramName while using this function.

Parameters:

emdkName - emdk name String

paramName - Parameter name String

paramValue - Parameter value String

Returns:

Returned in the format: emdkName.paramName=paramValue

processProfile

public EMDKResults processProfile(java.lang.String profileName,
                                  ProfileManager.PROFILE_FLAG profileFlag,
                                  org.w3c.dom.Document extraData)

Processes the given profile based on the data provided and the flag and return status of the action.

 
 Example Usage:
 DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
 DocumentBuilder db = dbf.newDocumentBuilder();
 Document extraData;
 extraData = db.newDocument();   
 profileManager.processProfile("Profile1", PROFILE_FLAG.GET, extraData);
  

Parameters:

profileName - Name of the profile. This parameter is mandatory. ex: 'Profile1'.

• You can also specify just part of the profile when a fully qualified name of the following format is given: [profileName][featureType][name in profile parameter] to just edit part of the profile. For example, if my profile is called 'Profile1' and the name in profile parameter is 'myName'. Passing 'profileName' as 'Profile1/ActivitySelection/myName' will just process this part of the profile.
• Valid [featureType]: ActivitySelection, Barcode, MSR, Intent, Keystroke, IP.

profileFlag - ProfileManager.PROFILE_FLAG

If the profileFlag is set to SET, and if the given profile is not available in the EMDKConfig.xml, it will look for valid profile in extraData argument and if present, the profile will be added to the internal XML volatile repository and also applied to the device. If the profile is present in the EMDKConfig.xml, it will be applied to the device.

If profileFlag is set to GET and if the profile is present in the internal repository, it will be returned in extraData.

extraData - This can be used to provide data for processing action.

Returns:

EMDKResults object.

processProfile

public EMDKResults processProfile(java.lang.String profileName,
                                  ProfileManager.PROFILE_FLAG profileFlag,
                                  java.lang.String[] extraData)

Processes the given profile based on the data provided and the flag and return status of the action.

 
 	Example Usage:
 	profileManager.processProfile("Profile1", PROFILE_FLAG.GET, new String[]{""});
 

Parameters:

profileName - Name of the profile. This parameter is mandatory. ex: 'Profile1'

• You can also specify just part of the profile when a fully qualified name of the following format is given: [profileName][featureType][name in profile parameter] to just edit part of the profile. For example, if my profile is called ‘EmdkSampleProfile-1’ and the name I gave to the Clock feature is 'clock1'. Passing 'profileName' as ' EmdkSampleProfile-1/Clock/clock1’ will just process this part of the profile.
• Valid [featureType]: ActivitySelection, Barcode, MSR, Intent, Keystroke, IP, Clock, PowerMgr, PersistMgr, CertMgr, AppMgr, AccessMgr, Wi-Fi, GprsMgr

profileFlag - ProfileManager.PROFILE_FLAG

If the profileFlag is set to SET, and if the given profile is not available in the EMDKConfig.xml, it will look for valid profile in extraData argument and if present, the profile will be added to the internal XML volatile repository and also applied to the device. If the profile is present in the EMDKConfig.xml, it will be applied to the device.

If profileFlag is set to GET and if the profile is present in the internal repository, it will be returned in extraData.

extraData - This can be used to provide data for processing action.

Returns:

EMDKResults object.

processProfile

@Deprecated
public EMDKResults processProfile(java.lang.String profileName,
                                               ProfileManager.PROFILE_FLAG profileFlag,
                                               ProfileConfig extraData)

Deprecated.

Processes the given profile based on the data provided and the flag and return status of the action.

 
 	Example Usage:
 	profileManager.processProfile("Profile1", PROFILE_FLAG.GET, ???);
 

Parameters:

profileName - Name of the profile. ex: 'Profile1'

• You can also specify just part of the profile when a fully qualified name of the following format is given: [profileName][featureType][name in profile parameter] to just edit part of the profile. For example, if my profile is called 'Profile1' and the name in profile parameter is 'myName'. Passing 'profileName' as 'Profile1/ActivitySelection/myName' will just process this part of the profile.
• Valid [featureType]: ActivitySelection, Barcode, MSR, Intent, Keystroke, IP

profileFlag - ProfileManager.PROFILE_FLAG

If the profileFlag is set to SET, and if the given profile is not available in the EMDKConfig.xml, it will look for valid profile in extraData argument and if present, the profile will be added to the internal XML volatile repository and also applied to the device. If the profile is present in the EMDKConfig.xml, it will be applied to the device.

If profileFlag is set to GET and if the profile is present in the internal repository, it will be returned in extraData.

extraData - ProfileConfig This can be used to provide data for processing action. This parameter is only supported for DataCapture profile features.

Returns:

EMDKResults object.

processProfileAsync

public EMDKResults processProfileAsync(java.lang.String profileName,
                                       ProfileManager.PROFILE_FLAG profileFlag,
                                       org.w3c.dom.Document extraData)

Processes the given profile based on the data provided and the flag and return status of the request. This is an asynchronous method and result will be returned through the registered callback.

 {@code
 Example Usage:
 
 public class MainActivity extends Activity implements EMDKListener, DataListener {
 
        profileManager.addDataListener(this); 
 
        profileManager.processProfileAsync("Profile1", PROFILE_FLAG.GET, null);

Parameters:

profileName - Name of the profile. This parameter is mandatory. ex: 'Profile1'.

profileFlag - ProfileManager.PROFILE_FLAG

If the profileFlag is set to SET, and if the given profile is not available in the EMDKConfig.xml, it will look for valid profile in extraData argument and if present, the profile will be added to the internal XML volatile repository and also applied to the device. If the profile is present in the EMDKConfig.xml, it will be applied to the device. The result will be returned to the application via data listener callback.

If profileFlag is set to GET and if the profile is present in the internal repository, it will be returned via data listener callback.

extraData - This can be used to provide data for processing action.

Returns:

EMDKResults object.

processProfileAsync

public EMDKResults processProfileAsync(java.lang.String profileName,
                                       ProfileManager.PROFILE_FLAG profileFlag,
                                       java.lang.String[] extraData)

Processes the given profile based on the data provided and the flag and return status of the request. This is an asynchronous method and result will be returned through the registered callback.

 {@code
        Example Usage:
 public class MainActivity extends Activity implements EMDKListener, DataListener {
 
        profileManager.addDataListener(this);
  
        profileManager.processProfileAsync("Profile1", PROFILE_FLAG.SET, extraData);

Parameters:

profileName - Name of the profile. This parameter is mandatory. ex: 'Profile1'.

profileFlag - ProfileManager.PROFILE_FLAG

If the profileFlag is set to SET, and if the given profile is not available in the EMDKConfig.xml, it will look for valid profile in extraData argument and if present, the profile will be added to the internal XML volatile repository and also applied to the device. If the profile is present in the EMDKConfig.xml, it will be applied to the device.

If profileFlag is set to GET and if the profile is present in the internal repository, it will be returned data listener callback.

extraData - This can be used to provide data for processing action.

Returns:

EMDKResults object.

processProfileAsync

@Deprecated
public EMDKResults processProfileAsync(java.lang.String profileName,
                                                    ProfileManager.PROFILE_FLAG profileFlag,
                                                    ProfileConfig extraData)

Deprecated.

Processes the given profile based on the data provided and the flag and return status of the request. This is an asynchronous method and result will be returned through the registered callback.

 {@code
        Example Usage:
 public class MainActivity extends Activity implements EMDKListener, DataListener {
 
        profileManager.addDataListener(this);
  
        profileManager.processProfileAsync("Profile1", PROFILE_FLAG.SET, null);

Parameters:

profileName - Name of the profile.

profileFlag - ProfileManager.PROFILE_FLAG

If the profileFlag is set to SET, and if the given profile is not available in the EMDKConfig.xml, it will look for valid profile in extraData argument and if present, the profile will be added to the internal XML volatile repository and also applied to the device. If the profile is present in the EMDKConfig.xml, it will be applied to the device.

If profileFlag is set to GET and if the profile is present in the internal repository, it will be returned via data listener callback..

extraData - ProfileConfig This can be used to provide data for processing action. This parameter is only supported for DataCapture profile features.

Returns:

EMDKResults object.

addDataListener

public void addDataListener(ProfileManager.DataListener listener)

The client can register to get data notification via callbacks.

Parameters:

listener -

removeDataListener

public void removeDataListener(ProfileManager.DataListener listener)

The client can un-register to get data notification via callbacks.

Parameters:

listener -