|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The PersonalStore Service The service should be intialized by calling intialize() before using any of the methods.
Field Summary | |
static int |
MAIL_ATTRIBUTE
search on mail attribute |
static int |
NAME_ATTRIBUTE
search on name attribute |
static int |
SEARCHTYPE_BYUID
Deprecated. use SEARCHTYPE_EQUALS |
static int |
SEARCHTYPE_CONTAINS
search by contain name |
static int |
SEARCHTYPE_ENDSWITH
search by end with name |
static int |
SEARCHTYPE_EQUALS
equals |
static int |
SEARCHTYPE_STARTSWITH
search by start with name |
static int |
UID_ATTRIBUTE
search on uid attribute |
Method Summary | |
void |
addPersonalStoreServiceListener(PersonalStoreServiceListener listener)
Add an additional PersonalStoreServiceListener to receive the event notifications. |
PersonalStoreEntry |
createEntry(CollaborationPrincipal principal,
java.lang.String entryType,
java.lang.String displayName)
creates a new entry on behalf of a specified user This method does not necessarily commit the entry to permanent storage. |
PersonalStoreEntry |
createEntry(java.lang.String entryType,
java.lang.String displayName)
creates a new entry This method does not necessarily commit the entry to permanent storage. |
java.util.Collection |
getEntries(java.lang.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. |
PersonalStoreEntry |
getEntry(CollaborationPrincipal principal,
java.lang.String entryType,
java.lang.String entryId)
retrieves a personal store entry from its entry id |
PersonalStoreEntry |
getEntry(java.lang.String entryType,
java.lang.String entryId)
retrieves a personal store entry from its entry id |
java.util.Collection |
getFolders(CollaborationPrincipal principal,
java.lang.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. |
java.util.Collection |
getFolders(java.lang.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. |
PersonalProfile |
getProfile()
get the profile info |
PersonalProfile |
getProfile(CollaborationPrincipal principal)
get the profile info |
void |
initialize(PersonalStoreServiceListener listener)
intialize the service by providing a PersonalStoreServiceListener. |
void |
removePersonalStoreServiceListener(PersonalStoreServiceListener listener)
Removes an already added ConfereneServiceListener. |
void |
save()
Commit unsaved personal store changes to the server |
PersonalStoreEntry[] |
search(int searchType,
java.lang.String pattern,
java.lang.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. |
PersonalStoreEntry[] |
search(int searchType,
java.lang.String pattern,
java.lang.String entryType,
int attribute)
|
CollaborationPrincipal[] |
searchPrincipals(int searchType,
java.lang.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. |
CollaborationPrincipal[] |
searchPrincipals(int searchType,
java.lang.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. |
Field Detail |
public static final int SEARCHTYPE_BYUID
public static final int SEARCHTYPE_CONTAINS
public static final int SEARCHTYPE_STARTSWITH
public static final int SEARCHTYPE_ENDSWITH
public static final int SEARCHTYPE_EQUALS
public static final int NAME_ATTRIBUTE
public static final int UID_ATTRIBUTE
public static final int MAIL_ATTRIBUTE
Method Detail |
public PersonalStoreEntry getEntry(java.lang.String entryType, java.lang.String entryId) throws CollaborationException
entryType
- entry type, as defined in PersonalStoreEntryentryId
- entry's unique id
CollaborationException
public PersonalStoreEntry getEntry(CollaborationPrincipal principal, java.lang.String entryType, java.lang.String entryId) throws CollaborationException
entryType
- entry type, as defined in PersonalStoreEntryentryId
- entry's unique idprincipal
- owner of the personal store to query
CollaborationException
public java.util.Collection getEntries(java.lang.String entryType) throws CollaborationException
note: retrieves only the folders, not the entries.
entryType
- folderType type of folder as defined in PersonalStoreEntryType
CollaborationException
public java.util.Collection getFolders(java.lang.String entryType) throws CollaborationException
note: retrieves only the folders, not the entries.
entryType
- folderType type of folder as defined in PersonalStoreEntryType
CollaborationException
public java.util.Collection getFolders(CollaborationPrincipal principal, java.lang.String entryType) throws CollaborationException
note: retrieves only the folders, not the entries.
principal
- owner of the personal store to queryentryType
- folderType type of folder as defined in PersonalStoreEntryType
CollaborationException
public PersonalStoreEntry createEntry(java.lang.String entryType, java.lang.String displayName) throws CollaborationException
entryType
- type of entry as defined in PersonalStoreEntryTypedisplayName
- entry display name
CollaborationException
public PersonalStoreEntry createEntry(CollaborationPrincipal principal, java.lang.String entryType, java.lang.String displayName) throws CollaborationException
principal
- owner ofd the personal store in which to add the
new entryentryType
- type of entry as defined in PersonalStoreEntryTypedisplayName
- entry display name
CollaborationException
public CollaborationPrincipal[] searchPrincipals(int searchType, java.lang.String pattern) throws CollaborationException
searchType
- type of search to performpattern
- searchName name to search for
CollaborationException
public CollaborationPrincipal[] searchPrincipals(int searchType, java.lang.String pattern, int attribute) throws CollaborationException
searchType
- type of search to performpattern
- searchName name to search forattribute
- Attribute on which to search for
CollaborationException
public PersonalStoreEntry[] search(int searchType, java.lang.String pattern, java.lang.String entryType) throws CollaborationException
searchType
- type of search to performpattern
- searchName name to search for
CollaborationException
public PersonalStoreEntry[] search(int searchType, java.lang.String pattern, java.lang.String entryType, int attribute) throws CollaborationException
searchType
- type of search to performpattern
- searchName name to search forentryType
- type of the entry to search forattribute
- Attribute on which to search for
CollaborationException
public PersonalProfile getProfile() throws CollaborationException
CollaborationException
public PersonalProfile getProfile(CollaborationPrincipal principal) throws CollaborationException
principal
- owner of the personal store to query
CollaborationException
public void save() throws CollaborationException
CollaborationException
public void initialize(PersonalStoreServiceListener listener) throws CollaborationException
listener
- PersonalStoreServiceListener
CollaborationException
public void addPersonalStoreServiceListener(PersonalStoreServiceListener listener)
initializing
PersonalStoreService.
listener
- PersonalStoreServiceListener The PersonalStoreServiceListener to be added.public void removePersonalStoreServiceListener(PersonalStoreServiceListener listener)
listener
- PersonalStoreServiceListener The PersonalStoreServiceListener to be removed.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |