Java Doc for AddressBook.java in  » Portal » Open-Portal » com » sun » addressbook » 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 » Portal » Open Portal » com.sun.addressbook 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.addressbook.Element
      com.sun.addressbook.AddressBook

All known Subclasses:   com.sun.addressbook.ldap.LdapAddressBook,  com.sun.addressbook.wabp.WabpAddressBook,  com.sun.ssoadapter.ab.pim.JPimAddressBook,
AddressBook
abstract public class AddressBook extends Element (Code)
Address Book abstract class: encapsulates the commands to be carried out on the address book. The Adapters implement the various commands.


Field Summary
protected  StringabID
     address book ID corresponding to this user's address book store.
protected  Stringlocale
     The locale of the address book user.
protected  ABStorestore
     Parent ABStore associated with this address book.

Constructor Summary
protected  AddressBook(ABStore store, String abID)
     Address Book constructor.

Method Summary
abstract public  voidadd(Element element)
     Add a new Element to the address book.
abstract public  voidaddGroupMember(Element element, Group group)
     Add an element to an existing group in the address book.
abstract public  voiddelete(Element element)
     Delete an Element from the address book.
abstract public  voiddeleteGroupMember(Element element, Group group)
     Delete an element from a group in the address book.
abstract public  Element[]fetch(ABFilter abFilter)
     Run a search on the address book given the contraints and filters specified in the ABFilter argument.
Parameters:
  abFilter - Definition of the contraints and the filters for thefetch.
abstract public  Element[]fetchGroupMembers(ABFilter filter, Group group)
    
public  StringgetAbID()
     Return the address book id for this address book.
public  StringgetLocale()
     Return the locale of the address book user.
public  ABStoregetStore()
     Return the ABStore for this address book.
abstract public  voidmodify(Element oldElement, Element newElement)
     Modify an Element from the address book.
abstract public  ABSearchTermnewABSearchTerm(String name, String value, boolean exact)
     Return the ABSearchTerm object corresponding to the service type.
abstract public  ABSearchTermnewABSearchTerm(ABSearchTerm term, int op)
     Return the ABSearchTerm object corresponding to the service type.
abstract public  ABSearchTermnewABSearchTerm(ABSearchTerm[] terms, int op)
     Return the ABSearchTerm object corresponding to the service type.
public  voidsetLocale(String locale)
     Set the locale of the address book user.

Field Detail
abID
protected String abID(Code)
address book ID corresponding to this user's address book store.



locale
protected String locale(Code)
The locale of the address book user.



store
protected ABStore store(Code)
Parent ABStore associated with this address book.




Constructor Detail
AddressBook
protected AddressBook(ABStore store, String abID)(Code)
Address Book constructor.
Parameters:
  store - The ABStore this address book belongs to




Method Detail
add
abstract public void add(Element element) throws ABStoreException, OperationNotSupportedException(Code)
Add a new Element to the address book.
Parameters:
  element - The new Element to be added including the unique identifier.
exception:
  ABStoreException - if unable to connect to back end service.
exception:
  OperationNotSupportedException - if the adapter doesnt support the functionality



addGroupMember
abstract public void addGroupMember(Element element, Group group) throws ABStoreException, OperationNotSupportedException(Code)
Add an element to an existing group in the address book.
Parameters:
  Element - The Element to be added.
Parameters:
  Group - The group to which the element is to be added.
exception:
  ABStoreException - if unable to connect to back end service.
exception:
  OperationNotSupportedException - if the adapter doesnt support the functionality



delete
abstract public void delete(Element element) throws ABStoreException, OperationNotSupportedException(Code)
Delete an Element from the address book.
Parameters:
  element - The Element to be deleted.
exception:
  ABStoreException - if unable to connect to back end service.
exception:
  OperationNotSupportedException - if the adapter doesnt support the functionality



deleteGroupMember
abstract public void deleteGroupMember(Element element, Group group) throws ABStoreException, OperationNotSupportedException(Code)
Delete an element from a group in the address book.
Parameters:
  element - The Element to be deleted.
Parameters:
  group - The Group to which the entry is to be deleted.
exception:
  ABStoreException - if unable to connect to back end service.
exception:
  OperationNotSupportedException - if the adapter doesnt support the functionality



fetch
abstract public Element[] fetch(ABFilter abFilter) throws ABStoreException, OperationNotSupportedException(Code)
Run a search on the address book given the contraints and filters specified in the ABFilter argument.
Parameters:
  abFilter - Definition of the contraints and the filters for thefetch. Array of Address Book Element objects.
exception:
  ABStoreException - if unable to connect to back end service.
exception:
  OperationNotSupportedException - if the adapter doesnt support the functionality



fetchGroupMembers
abstract public Element[] fetchGroupMembers(ABFilter filter, Group group) throws ABStoreException, OperationNotSupportedException(Code)
Fetch the address book entries in the specified group String array of Elements in the address book.
exception:
  ABStoreException - if unable to connect to back end service.
exception:
  OperationNotSupportedException - if the adapter doesnt support the functionality



getAbID
public String getAbID()(Code)
Return the address book id for this address book. address book id associated with this address book.



getLocale
public String getLocale()(Code)
Return the locale of the address book user. Locale string for the user.



getStore
public ABStore getStore()(Code)
Return the ABStore for this address book. address book store associated with this address book.



modify
abstract public void modify(Element oldElement, Element newElement) throws ABStoreException, OperationNotSupportedException(Code)
Modify an Element from the address book.
Parameters:
  oldElement - The Element in the address book to be replaced.
Parameters:
  newElement - The new Element to replace the exisiting element.
exception:
  ABStoreException - if unable to connect to back end service.
exception:
  OperationNotSupportedException - if the adapter doesnt support the functionality



newABSearchTerm
abstract public ABSearchTerm newABSearchTerm(String name, String value, boolean exact)(Code)
Return the ABSearchTerm object corresponding to the service type. ABSearchTerm object corresponding to the service type.



newABSearchTerm
abstract public ABSearchTerm newABSearchTerm(ABSearchTerm term, int op) throws ABStoreException(Code)
Return the ABSearchTerm object corresponding to the service type. ABSearchTerm object corresponding to the service type.



newABSearchTerm
abstract public ABSearchTerm newABSearchTerm(ABSearchTerm[] terms, int op) throws ABStoreException(Code)
Return the ABSearchTerm object corresponding to the service type. ABSearchTerm object corresponding to the service type.



setLocale
public void setLocale(String locale)(Code)
Set the locale of the address book user.
Parameters:
  Locale - string for the user.



Fields inherited from com.sun.addressbook.Element
final public static int ADDRESSBOOK(Code)(Java Doc)
final public static int ALL(Code)(Java Doc)
final public static int ENTRY(Code)(Java Doc)
final public static int GROUP(Code)(Java Doc)
final public static int UNSPECIFIED(Code)(Java Doc)
protected String cn(Code)(Java Doc)
protected String description(Code)(Java Doc)
protected int elementType(Code)(Java Doc)
protected String entryid(Code)(Java Doc)
protected Map properties(Code)(Java Doc)
protected String un(Code)(Java Doc)

Methods inherited from com.sun.addressbook.Element
public String getCn()(Code)(Java Doc)
public String getDescription()(Code)(Java Doc)
public int getElementType()(Code)(Java Doc)
public String getEntryid()(Code)(Java Doc)
public Object getProperty(String property)(Code)(Java Doc)
public String getUn()(Code)(Java Doc)
public boolean hasProperty(String property)(Code)(Java Doc)
public boolean isAddressBook()(Code)(Java Doc)
public boolean isEntry()(Code)(Java Doc)
public boolean isGroup()(Code)(Java Doc)
public void setCn(String value)(Code)(Java Doc)
public void setDescription(String value)(Code)(Java Doc)
public void setElementType(int elementType)(Code)(Java Doc)
public void setEntryid(String value)(Code)(Java Doc)
public void setProperty(String property, Object value)(Code)(Java Doc)
public void setUn(String value)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(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.