| org.netbeans.lib.collab.PersonalStoreService
All known Subclasses: org.netbeans.lib.collab.xmpp.XMPPPersonalStoreService,
| PersonalStoreService | | public interface PersonalStoreService (Code) | | The PersonalStore Service
The service should be intialized by calling intialize() before using any
of the methods.
since:
version 0.1 |
| Method Summary | |
| public void | addPersonalStoreServiceListener(PersonalStoreServiceListener listener)
Add an additional PersonalStoreServiceListener to receive the event notifications. | | public PersonalStoreEntry | createEntry(String entryType, String displayName)
creates a new entry
This method does not necessarily commit the entry to permanent storage.
The other attributes of the created entry need to be set using the
methods in PersonalStoreEntry or subclass thereof. | | public PersonalStoreEntry | createEntry(CollaborationPrincipal principal, String entryType, String displayName)
creates a new entry on behalf of a specified user
This method does not necessarily commit the entry to permanent storage.
The other attributes of the created entry need to be set using the
methods in PersonalStoreEntry or subclass thereof. | | public java.util.Collection | getEntries(String entryType)
retrieves all entries of a specific type from the personal
store
note: this assumes there aren't too many folders in the personal store
note: retrieves only the folders, not the entries. | | public PersonalStoreEntry | getEntry(String entryType, String entryId)
| | public PersonalStoreEntry | getEntry(CollaborationPrincipal principal, String entryType, String entryId)
| | public java.util.Collection | getFolders(String entryType)
retrieves all the folders in the personal store
note: this assumes there aren't too many folders in the personal store
note: retrieves only the folders, not the entries. | | public java.util.Collection | getFolders(CollaborationPrincipal principal, String entryType)
retrieves all the folders in the personal store of a specified principal
note: this assumes there aren't too many folders in the personal store
note: retrieves only the folders, not the entries. | | public PersonalProfile | getProfile()
| | public PersonalProfile | getProfile(CollaborationPrincipal principal)
| | public void | initialize(PersonalStoreServiceListener listener)
intialize the service by providing a PersonalStoreServiceListener. | | public void | removePersonalStoreServiceListener(PersonalStoreServiceListener listener)
Removes an already added ConfereneServiceListener. | | public void | save()
| | public PersonalStoreEntry[] | search(int searchType, String pattern, String entryType)
search directory for entry
This method search the corporate directory for entries that can then be
used to add as a PersonalContact to the PersonalStoreFolder.
There are four types of search criteria: BYUID, CONTAINNAME, STARTNAME,
ENDNAME. | | public PersonalStoreEntry[] | search(int searchType, String pattern, String entryType, int attribute)
| | public CollaborationPrincipal[] | searchPrincipals(int searchType, String pattern)
search directory for entry
This method search the corporate directory for entries that can then
be used to add as a PersonalContact to the PersonalStoreFolder.
There are four types of search criteria: BYUID, CONTAINNAME, STARTNAME,
ENDNAME. | | public CollaborationPrincipal[] | searchPrincipals(int searchType, String pattern, int attribute)
search directory for entry
This method search the corporate directory for entries that can
then be used to add as a PersonalContact to the PersonalStoreFolder.
There are four types of search criteria: BYUID, CONTAINNAME, STARTNAME,
ENDNAME. |
| MAIL_ATTRIBUTE | | final public static int MAIL_ATTRIBUTE(Code) | | search on mail attribute
|
| NAME_ATTRIBUTE | | final public static int NAME_ATTRIBUTE(Code) | | search on name attribute
|
| SEARCHTYPE_CONTAINS | | final public static int SEARCHTYPE_CONTAINS(Code) | | search by contain name
|
| SEARCHTYPE_ENDSWITH | | final public static int SEARCHTYPE_ENDSWITH(Code) | | search by end with name
|
| SEARCHTYPE_EQUALS | | final public static int SEARCHTYPE_EQUALS(Code) | | equals
|
| SEARCHTYPE_STARTSWITH | | final public static int SEARCHTYPE_STARTSWITH(Code) | | search by start with name
|
| UID_ATTRIBUTE | | final public static int UID_ATTRIBUTE(Code) | | search on uid attribute
|
| addPersonalStoreServiceListener | | public void addPersonalStoreServiceListener(PersonalStoreServiceListener listener)(Code) | | Add an additional PersonalStoreServiceListener to receive the event notifications.
To receive all the initial events the first PersonalStoreServiceListener should be
added while
PersonalStoreService.initialize initializing PersonalStoreService.
Parameters:
listener - PersonalStoreServiceListener The PersonalStoreServiceListener to be added. |
| createEntry | | public PersonalStoreEntry createEntry(String entryType, String displayName) throws CollaborationException(Code) | | creates a new entry
This method does not necessarily commit the entry to permanent storage.
The other attributes of the created entry need to be set using the
methods in PersonalStoreEntry or subclass thereof. In particular,
the folder(s) referencing this entry must be specified using
PersonalStoreEntry.addToFolder().
After the entry is complete, it must be committed with its save()
method.
Parameters:
entryType - type of entry as defined in PersonalStoreEntryType
Parameters:
displayName - entry display name a new entry, which class depends on the specified type.Note that the returned entry may be a folder. |
| createEntry | | public PersonalStoreEntry createEntry(CollaborationPrincipal principal, String entryType, String displayName) throws CollaborationException(Code) | | creates a new entry on behalf of a specified user
This method does not necessarily commit the entry to permanent storage.
The other attributes of the created entry need to be set using the
methods in PersonalStoreEntry or subclass thereof. In particular,
the folder(s) referencing this entry must be specified using
PersonalStoreEntry.addToFolder().
After the entry is complete, it must be committed with its save()
method.
Parameters:
principal - owner ofd the personal store in which to add thenew entry
Parameters:
entryType - type of entry as defined in PersonalStoreEntryType
Parameters:
displayName - entry display name a new entry, which class depends on the specified type.Note that the returned entry may be a folder. |
| getEntries | | public java.util.Collection getEntries(String entryType) throws CollaborationException(Code) | | retrieves all entries of a specific type from the personal
store
note: this assumes there aren't too many folders in the personal store
note: retrieves only the folders, not the entries.
Parameters:
entryType - folderType type of folder as defined in PersonalStoreEntryType a Collection of PersonalStoreFolder objects |
| getFolders | | public java.util.Collection getFolders(String entryType) throws CollaborationException(Code) | | retrieves all the folders in the personal store
note: this assumes there aren't too many folders in the personal store
note: retrieves only the folders, not the entries.
Parameters:
entryType - folderType type of folder as defined in PersonalStoreEntryType a Collection of PersonalStoreFolder objects |
| getFolders | | public java.util.Collection getFolders(CollaborationPrincipal principal, String entryType) throws CollaborationException(Code) | | retrieves all the folders in the personal store of a specified principal
note: this assumes there aren't too many folders in the personal store
note: retrieves only the folders, not the entries.
Parameters:
principal - owner of the personal store to query
Parameters:
entryType - folderType type of folder as defined in PersonalStoreEntryType a Collection of PersonalStoreFolder objects |
| initialize | | public void initialize(PersonalStoreServiceListener listener) throws CollaborationException(Code) | | intialize the service by providing a PersonalStoreServiceListener.
Service should be initialized by calling this method before using
any of the services of PersonalStoreService
Parameters:
listener - PersonalStoreServiceListener |
| removePersonalStoreServiceListener | | public void removePersonalStoreServiceListener(PersonalStoreServiceListener listener)(Code) | | Removes an already added ConfereneServiceListener. To prevent loss of any event
notification it is advised to have atleast one PersonalStoreServiceListener
Parameters:
listener - PersonalStoreServiceListener The PersonalStoreServiceListener to be removed. |
| search | | public PersonalStoreEntry[] search(int searchType, String pattern, String entryType) throws CollaborationException(Code) | | search directory for entry
This method search the corporate directory for entries that can then be
used to add as a PersonalContact to the PersonalStoreFolder.
There are four types of search criteria: BYUID, CONTAINNAME, STARTNAME,
ENDNAME. When a particular one is choosed to be added to a folder,
pass that as the argument to the createEntry() method.
Parameters:
searchType - type of search to perform
Parameters:
pattern - searchName name to search for a array of principals from the search result,or null if none matched |
| search | | public PersonalStoreEntry[] search(int searchType, String pattern, String entryType, int attribute) throws CollaborationException(Code) | |
Parameters:
searchType - type of search to perform
Parameters:
pattern - searchName name to search for
Parameters:
entryType - type of the entry to search for
Parameters:
attribute - Attribute on which to search for a array of principals from the search result,or null if none matched |
| searchPrincipals | | public CollaborationPrincipal[] searchPrincipals(int searchType, String pattern) throws CollaborationException(Code) | | search directory for entry
This method search the corporate directory for entries that can then
be used to add as a PersonalContact to the PersonalStoreFolder.
There are four types of search criteria: BYUID, CONTAINNAME, STARTNAME,
ENDNAME. When a particular one is choosed to be added to a folder,
pass that as the argument to the createEntry() method.
Parameters:
searchType - type of search to perform
Parameters:
pattern - searchName name to search for a array of principals from the search result,or null if none matched |
| searchPrincipals | | public CollaborationPrincipal[] searchPrincipals(int searchType, String pattern, int attribute) throws CollaborationException(Code) | | search directory for entry
This method search the corporate directory for entries that can
then be used to add as a PersonalContact to the PersonalStoreFolder.
There are four types of search criteria: BYUID, CONTAINNAME, STARTNAME,
ENDNAME. When a particular one is choosed to be added to a folder,
pass that as the argument to the createEntry() method.
The attribute for the search can be NAME_ATTRIBUTE or UID_ATTRIBUTE
or MAIL_ATTRIBUTE
Parameters:
searchType - type of search to perform
Parameters:
pattern - searchName name to search for
Parameters:
attribute - Attribute on which to search for a array of principals from the search result,or null if none matched |
|
|