|
Oracle® Collaboration Suite Contacts Java API Reference 10g Release 1 (10.1.1) B16235-01 |
|||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.collabsuite.addressbook.AddressBookObject | +--oracle.collabsuite.addressbook.AddressBookList
This class represents a private list in user address book. Using methods in this class, various attributes of a list can be retrived or modified.
Method Summary | |
void |
addContactMembers(AddressBookContact[] contacts) Adds the given contacts to this private list |
void |
addContactNListMembers(AddressBookContact[] contacts, AddressBookList[] lists) Adds the given contacts and list to this private list |
void |
addListMembers(AddressBookList[] lists) Adds the given lists from this private list |
void |
delete() Deletes this list from the user's addressbook. |
void |
deleteContactMembers(AddressBookContact[] contacts) Removes the given contacts from this private list |
void |
deleteContactNListMembers(AddressBookContact[] contacts, AddressBookList[] lists) Removes the given contacts and lists from this private list |
void |
deleteListMembers(AddressBookList[] lists) Removes the given lists from this private list |
java.lang.String[] |
getAttributeNames() Returns an array of String containing the name of all the attribute names currently cached in this object |
AddressBookAttribute[] |
getAttributes(java.lang.String[] attributeNames) Returns the attribute values for the list of list attributes. |
AddressBookContact[] |
getContactMembers(java.lang.String[] contactAttrs) Returns contacts who are members of this private list |
java.lang.String |
getDN() Returns the DN of the list. |
java.lang.String |
getGUID() Returns the GUID of the list. |
AddressBookList[] |
getListMembers(java.lang.String[] listAttrs) Returns the other lists who are members of this private list |
java.util.Hashtable |
getMembers(java.lang.String[] membAttrs) Returns the members of this private list. |
java.lang.String |
getOwnerDN() Returns the DN of the list owner. |
java.lang.String |
getOwnerGUID() Returns the GUID of the list owner. |
boolean |
ifWritable() This API lets the caller know if this list is writable or not. |
void |
modifyMembers(AddressBookContact[] contacts, AddressBookList[] lists, int modType) Adds/deletes/replaces the given contacts and lists from this private list based on the modification type |
void |
refresh(java.lang.String[] attributeNames) Refreshes this list entry |
java.util.Vector |
resolve(java.lang.String[] resolutionType) This method resolves this list to the given resolution types. |
void |
setAttributes(AddressBookAttribute[] mods) Sets the value of the given list attributes |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public java.lang.String getDN()
void
-public java.lang.String getGUID()
void
-public java.lang.String getOwnerDN()
void
-public java.lang.String getOwnerGUID()
void
-public boolean ifWritable()
void
-public AddressBookAttribute[] getAttributes(java.lang.String[] attributeNames) throws AddressBookException
attributeNames
- Names of the attribute whose values are to be fetchedpublic void refresh(java.lang.String[] attributeNames) throws AddressBookException
attributeNames
- Names of the attribute whose values are to be fetched. null means fetch all attributespublic java.lang.String[] getAttributeNames()
public void setAttributes(AddressBookAttribute[] mods) throws AddressBookException
mods
- An array of AddressBookAttribute for each attribute to be modified. The following example shows how to delete the mail id of the list ...mailAttr = new AddressBookAttribute(AddressBookListConstants.MAILADRESSES); mailAttr.setValue(AddressBookListConstants.DELETE_ATTRIBUTE, "tuser1@oracle.com");public java.util.Hashtable getMembers(java.lang.String[] membAttrs) throws AddressBookException
listAttrs
- The list/contact member attributes to fetchpublic AddressBookContact[] getContactMembers(java.lang.String[] contactAttrs) throws AddressBookException
contactAttrs
- The contact member attributes to fetchpublic AddressBookList[] getListMembers(java.lang.String[] listAttrs) throws AddressBookException
listAttrs
- The list member attributes to fetchpublic void addContactMembers(AddressBookContact[] contacts) throws AddressBookException
contacts
- an array of contactspublic void deleteContactMembers(AddressBookContact[] contacts) throws AddressBookException
contacts
- an array of contactspublic void addListMembers(AddressBookList[] lists) throws AddressBookException
lists
- an array of listspublic void deleteListMembers(AddressBookList[] lists) throws AddressBookException
lists
- an array listspublic void addContactNListMembers(AddressBookContact[] contacts, AddressBookList[] lists) throws AddressBookException
contacts
- an array of contactslists
- an array of listspublic void deleteContactNListMembers(AddressBookContact[] contacts, AddressBookList[] lists) throws AddressBookException
contacts
- an array of contactslists
- an array of listspublic void modifyMembers(AddressBookContact[] contacts, AddressBookList[] lists, int modType) throws AddressBookException
contacts
- an array of contactslists
- an array of listsmodType
- - The type of modification add/delete/replace [Use constants AddressBookConstants.ADD_ATTRIBUTE AddressBookConstants.DELETE_ATTRIBUTE and AddressBookConstants.REPLACE_ATTRIBUTE]public java.util.Vector resolve(java.lang.String[] resolutionType) throws AddressBookException
resolutionType
- The resolution type, which is the attribute names to resolve to, for example array containing MAILID, SECONDARY_EMAIL etc. It's an array os Stringspublic void delete() throws AddressBookException
void
-
|
Oracle® Collaboration Suite Contacts Java API Reference 10g Release 1 (10.1.1) B16235-01 |
|||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |