Java Doc for PIMProxy.java in  » 6.0-JDK-Modules » j2me » com » sun » kvem » midp » pim » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » com.sun.kvem.midp.pim 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.kvem.midp.pim.PIMHandler
      com.sun.kvem.midp.pim.PIMProxy

PIMProxy
public class PIMProxy extends PIMHandler (Code)
Porting layer implementation for PIM functionality.


Field Summary
final public static  intCONTACT_LIST
     Constant representing a Contact List.
final public static  intEVENT_LIST
     Constant representing an Event List.
final public static  intTODO_LIST
     Constant representing a ToDo List.


Method Summary
public  voidaddCategory(Object listHandle, String category)
     Adds a category to the categories defined for a list.
public  voidcloseList(Object listHandle)
     Closes list.
public synchronized  ObjectcommitListElement(Object listHandle, Object elementKey, byte[] element, String[] categories)
     Commit a list element.
public  voiddeleteCategory(Object listHandle, String category)
     Deletes a category from the categories defined for a list.
public  StringgetArrayElementLabel(Object listHandle, int field, int arrayElement)
     Gets the array element label.
public  StringgetAttributeLabel(Object listHandle, int attribute)
     Gets attribute label for the given field attribute.
public  String[]getCategories(Object listHandle)
     Gets the set of categories defined for a list.
public  byte[]getDefaultBinaryValue(Object listHandle, int field)
     Gets the default byte[] value for the given field.
public  booleangetDefaultBooleanValue(Object listHandle, int field)
     Gets the default boolean value for the given field.
public  longgetDefaultDateValue(Object listHandle, int field)
     Gets the default date value for the given field.
public  intgetDefaultIntValue(Object listHandle, int field)
     Gets the default integer value for the given field.
public  StringgetDefaultListName(int listType)
     Get the name of the default list for the given type.
public  String[]getDefaultStringArrayValue(Object listHandle, int field)
     Gets the default String[] value for the given field.
public  StringgetDefaultStringValue(Object listHandle, int field)
     Gets the default string value for the given field.
public  intgetFieldDataType(Object listHandle, int field)
     Gets the data type of the field.
public  StringgetFieldLabel(Object listHandle, int field)
     Gets the label of the field.
public  byte[]getListElement(Object listHandle, Object elementKey)
     Get the data for a list element.
public  String[]getListElementCategories(Object listHandle, Object elementKey)
     Get categories for the specified list element.
public synchronized  Object[]getListKeys(Object listHandle)
     Get list element keys.
Parameters:
  listHandle - handle of the list an array of objects representing PIM element keys.
public synchronized  String[]getListNames(int listType)
     Get the supported list names for the given list type.
public  intgetMaximumValues(Object listHandle, int field)
     Get the maximum number of values that can be stored in the given field.
public  intgetStringArraySize(Object listHandle, int field)
     Checks if size of the string array.
public  int[]getSupportedArrayElements(Object listHandle, int field)
     Gets the array of supported elements.
public  int[]getSupportedAttributes(Object listHandle, int field)
     Gets the supported attributes for the given field.
public  intgetSupportedAttributesMask(Object listHandle, int field)
     Gets a mask containing all possible attributes for the given field.
public  int[]getSupportedFields(Object listHandle)
     Gets all fields that are supported in this list.
public  booleanhasDefaultValue(Object listHandle, int field)
     Checks if field has default value.
public  booleanisSupportedArrayElement(Object listHandle, int field, int arrayElement)
     Checks if the array element is supported.
public  booleanisSupportedAttribute(Object listHandle, int field, int attribute)
     Checks if attribute is supported.
public  booleanisSupportedField(Object listHandle, int field)
     Checks if field is supported in list.
public  ObjectopenList(int listType, String listName, int openMode)
     Opens list.
public  voidrenameCategory(Object listHandle, String currentCategory, String newCategory)
     Rename a category.

Field Detail
CONTACT_LIST
final public static int CONTACT_LIST(Code)
Constant representing a Contact List. List handle for which fields have been already initialized.



EVENT_LIST
final public static int EVENT_LIST(Code)
Constant representing an Event List.



TODO_LIST
final public static int TODO_LIST(Code)
Constant representing a ToDo List.





Method Detail
addCategory
public void addCategory(Object listHandle, String category) throws PIMException(Code)
Adds a category to the categories defined for a list.
Parameters:
  listHandle - handle of list
Parameters:
  category - category name
throws:
  PIMException - If an error occurs orthe list is no longer accessible or closed.
See Also:   PIMProxy.getCategories



closeList
public void closeList(Object listHandle) throws PIMException(Code)
Closes list.
Parameters:
  listHandle - handle of list
throws:
  PIMException - in case of I/O error.



commitListElement
public synchronized Object commitListElement(Object listHandle, Object elementKey, byte[] element, String[] categories) throws PIMException(Code)
Commit a list element.
Parameters:
  listHandle - handle of the list
Parameters:
  elementKey - the key of the element to be stored, or null if thisis a new element.
Parameters:
  element - element data in a form that can be interpretedby getListElement()
Parameters:
  categories - list of categories which the list element belongs to a non-null key for this element, to be used in future callsto commitListElement() and getListElement()
throws:
  PIMException - in case of I/O error.



deleteCategory
public void deleteCategory(Object listHandle, String category) throws PIMException(Code)
Deletes a category from the categories defined for a list.
Parameters:
  listHandle - handle of list
Parameters:
  category - category name
throws:
  PIMException - If an error occurs orthe list is no longer accessible or closed.
See Also:   PIMProxy.getCategories



getArrayElementLabel
public String getArrayElementLabel(Object listHandle, int field, int arrayElement)(Code)
Gets the array element label.
Parameters:
  listHandle - handle of the list
Parameters:
  field - the field number
Parameters:
  arrayElement - the element identifier label fro the array element



getAttributeLabel
public String getAttributeLabel(Object listHandle, int attribute)(Code)
Gets attribute label for the given field attribute.
Parameters:
  listHandle - handle of the list
Parameters:
  attribute - identifier of attribute attribute label



getCategories
public String[] getCategories(Object listHandle) throws PIMException(Code)
Gets the set of categories defined for a list.
Parameters:
  listHandle - handle of the list the set of defined categories
throws:
  PIMException - If an error occurs orthe list is no longer accessible or closed.



getDefaultBinaryValue
public byte[] getDefaultBinaryValue(Object listHandle, int field)(Code)
Gets the default byte[] value for the given field. This will only return a valid value if hasDefaultValue(listType, field) returns true.
Parameters:
  listHandle - handle of the list
Parameters:
  field - identifier of field default value of the field



getDefaultBooleanValue
public boolean getDefaultBooleanValue(Object listHandle, int field)(Code)
Gets the default boolean value for the given field. This will only return a valid value if hasDefaultValue(listType, field) returns true.
Parameters:
  listHandle - handle of the list
Parameters:
  field - identifier of field default value of the field



getDefaultDateValue
public long getDefaultDateValue(Object listHandle, int field)(Code)
Gets the default date value for the given field. This will only return a valid value if hasDefaultValue(listType, field) returns true.
Parameters:
  listHandle - handle of the list
Parameters:
  field - identifier of field default value of the field



getDefaultIntValue
public int getDefaultIntValue(Object listHandle, int field)(Code)
Gets the default integer value for the given field. This will only return a valid value if hasDefaultValue(listType, field) returns true.
Parameters:
  listHandle - handle of the list
Parameters:
  field - identifier of field default value of the field



getDefaultListName
public String getDefaultListName(int listType)(Code)
Get the name of the default list for the given type.
Parameters:
  listType - the type of the list the name of the default list, or null if no list of this typeis supported.



getDefaultStringArrayValue
public String[] getDefaultStringArrayValue(Object listHandle, int field)(Code)
Gets the default String[] value for the given field. This will only return a valid value if hasDefaultValue(listType, field) returns true.
Parameters:
  listHandle - handle of the list
Parameters:
  field - identifier of field default value of the field



getDefaultStringValue
public String getDefaultStringValue(Object listHandle, int field)(Code)
Gets the default string value for the given field. This will only return a valid value if hasDefaultValue(listType, field) returns true.
Parameters:
  listHandle - handle of the list
Parameters:
  field - identifier of field default value of the field



getFieldDataType
public int getFieldDataType(Object listHandle, int field)(Code)
Gets the data type of the field.
Parameters:
  listHandle - handle of the list
Parameters:
  field - identifier of field data type identifier



getFieldLabel
public String getFieldLabel(Object listHandle, int field)(Code)
Gets the label of the field.
Parameters:
  listHandle - handle of the list
Parameters:
  field - identifier of field label of the field



getListElement
public byte[] getListElement(Object listHandle, Object elementKey) throws PIMException(Code)
Get the data for a list element.
Parameters:
  listHandle - handle of the list
Parameters:
  elementKey - the key of the requested element a byte array containing the element data in a supported format
throws:
  PIMException - in case of I/O error.



getListElementCategories
public String[] getListElementCategories(Object listHandle, Object elementKey) throws PIMException(Code)
Get categories for the specified list element.
Parameters:
  listHandle - handle of list
Parameters:
  elementKey - the key of the requested element an array of categories names
throws:
  PIMException - in case of I/O error.



getListKeys
public synchronized Object[] getListKeys(Object listHandle) throws PIMException(Code)
Get list element keys.
Parameters:
  listHandle - handle of the list an array of objects representing PIM element keys. These keysare to be passed to getListElement() and commitListElement().
throws:
  PIMException - in case of I/O error.



getListNames
public synchronized String[] getListNames(int listType)(Code)
Get the supported list names for the given list type. All list elements must be unique within the list.
Parameters:
  listType - the type of the list a non-null array of supported list names. A copy of this array isreturned by PIM.listPIMLists()



getMaximumValues
public int getMaximumValues(Object listHandle, int field)(Code)
Get the maximum number of values that can be stored in the given field.
Parameters:
  listHandle - handle of the list
Parameters:
  field - the field type the maximum value



getStringArraySize
public int getStringArraySize(Object listHandle, int field)(Code)
Checks if size of the string array.
Parameters:
  listHandle - handle of the list
Parameters:
  field - the field number size of the string array



getSupportedArrayElements
public int[] getSupportedArrayElements(Object listHandle, int field)(Code)
Gets the array of supported elements.
Parameters:
  listHandle - handle of the list
Parameters:
  field - the field number array of supported elements



getSupportedAttributes
public int[] getSupportedAttributes(Object listHandle, int field)(Code)
Gets the supported attributes for the given field.
Parameters:
  listHandle - handle of the list
Parameters:
  field - identifier of field array of supported attributes of the field



getSupportedAttributesMask
public int getSupportedAttributesMask(Object listHandle, int field)(Code)
Gets a mask containing all possible attributes for the given field.
Parameters:
  listHandle - handle of the list
Parameters:
  field - the field number supported attribute mask



getSupportedFields
public int[] getSupportedFields(Object listHandle)(Code)
Gets all fields that are supported in this list. All fields supported by this list, including both standard and extended, are returned in this array.
Parameters:
  listHandle - handle of the list an int array containing all fields supported by this list. Theorder of the fields returned is unspecified. If there are nosupported fields, a zero-length array is returned.



hasDefaultValue
public boolean hasDefaultValue(Object listHandle, int field)(Code)
Checks if field has default value.
Parameters:
  listHandle - handle of the list
Parameters:
  field - identifier of field true if field supported



isSupportedArrayElement
public boolean isSupportedArrayElement(Object listHandle, int field, int arrayElement)(Code)
Checks if the array element is supported.
Parameters:
  listHandle - handle of the list
Parameters:
  field - the field number
Parameters:
  arrayElement - the element identifier true if attribute element is supported



isSupportedAttribute
public boolean isSupportedAttribute(Object listHandle, int field, int attribute)(Code)
Checks if attribute is supported.
Parameters:
  listHandle - handle of the list
Parameters:
  field - the field number
Parameters:
  attribute - identifier of attribute true if attribute is supported



isSupportedField
public boolean isSupportedField(Object listHandle, int field)(Code)
Checks if field is supported in list.
Parameters:
  listHandle - handle of the list
Parameters:
  field - identifier of field true if field supported



openList
public Object openList(int listType, String listName, int openMode) throws PIMException(Code)
Opens list.
Parameters:
  listType - the type of the list
Parameters:
  listName - the name of the list
Parameters:
  openMode - open mode: list handle that will be used to access this list
throws:
  PIMException - in case of I/O error.



renameCategory
public void renameCategory(Object listHandle, String currentCategory, String newCategory) throws PIMException(Code)
Rename a category.
Parameters:
  listHandle - handle of list
Parameters:
  currentCategory - current category name
Parameters:
  newCategory - new category name
throws:
  PIMException - If an error occurs orthe list is no longer accessible or closed.
See Also:   PIMProxy.getCategories



Methods inherited from com.sun.kvem.midp.pim.PIMHandler
abstract public void addCategory(Object listHandle, String category) throws PIMException(Code)(Java Doc)
abstract public void closeList(Object listHandle) throws PIMException(Code)(Java Doc)
abstract public Object commitListElement(Object listHandle, Object elementKey, byte[] element, String[] categories) throws PIMException(Code)(Java Doc)
public String composeDate(long date)(Code)(Java Doc)
public String composeDate1(long date)(Code)(Java Doc)
public String composeDateTime(long date)(Code)(Java Doc)
abstract public void deleteCategory(Object listHandle, String category) throws PIMException(Code)(Java Doc)
abstract public String getArrayElementLabel(Object listHandle, int field, int arrayElement)(Code)(Java Doc)
abstract public String getAttributeLabel(Object listHandle, int attribute)(Code)(Java Doc)
abstract public String[] getCategories(Object listHandle) throws PIMException(Code)(Java Doc)
abstract public byte[] getDefaultBinaryValue(Object listHandle, int field)(Code)(Java Doc)
abstract public boolean getDefaultBooleanValue(Object listHandle, int field)(Code)(Java Doc)
abstract public long getDefaultDateValue(Object listHandle, int field)(Code)(Java Doc)
abstract public int getDefaultIntValue(Object listHandle, int field)(Code)(Java Doc)
abstract public String getDefaultListName(int listType)(Code)(Java Doc)
abstract public String[] getDefaultStringArrayValue(Object listHandle, int field)(Code)(Java Doc)
abstract public String getDefaultStringValue(Object listHandle, int field)(Code)(Java Doc)
abstract public int getFieldDataType(Object listHandle, int field)(Code)(Java Doc)
abstract public String getFieldLabel(Object listHandle, int field)(Code)(Java Doc)
public static PIMHandler getInstance()(Code)(Java Doc)
abstract public byte[] getListElement(Object listHandle, Object elementKey) throws PIMException(Code)(Java Doc)
abstract public String[] getListElementCategories(Object listHandle, Object elementKey) throws PIMException(Code)(Java Doc)
abstract public Object[] getListKeys(Object listHandle) throws PIMException(Code)(Java Doc)
abstract public String[] getListNames(int listType)(Code)(Java Doc)
abstract public int getMaximumValues(Object listHandle, int field)(Code)(Java Doc)
abstract public int getStringArraySize(Object listHandle, int field)(Code)(Java Doc)
abstract public int[] getSupportedArrayElements(Object listHandle, int field)(Code)(Java Doc)
abstract public int[] getSupportedAttributes(Object listHandle, int field)(Code)(Java Doc)
abstract public int getSupportedAttributesMask(Object listHandle, int field)(Code)(Java Doc)
abstract public int[] getSupportedFields(Object listHandle)(Code)(Java Doc)
abstract public boolean hasDefaultValue(Object listHandle, int field)(Code)(Java Doc)
abstract public boolean isSupportedArrayElement(Object listHandle, int field, int arrayElement)(Code)(Java Doc)
abstract public boolean isSupportedAttribute(Object listHandle, int field, int attribute)(Code)(Java Doc)
abstract public boolean isSupportedField(Object listHandle, int field)(Code)(Java Doc)
abstract public Object openList(int listType, String listName, int openMode) throws PIMException(Code)(Java Doc)
public long parseDate(String s)(Code)(Java Doc)
public long parseDateTime(String s)(Code)(Java Doc)
abstract public void renameCategory(Object listHandle, String currentCategory, String newCategory) throws PIMException(Code)(Java Doc)

Methods inherited from java.lang.Object
public boolean equals(Object obj)(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.