com.sun.im.service
Interface PersonalStoreEntry

All Known Subinterfaces:
PersonalConference, PersonalContact, PersonalGateway, PersonalGroup, PersonalProfile, PersonalStoreFolder, Watcher

public interface PersonalStoreEntry


Field Summary
static java.lang.String BOOKMARK
          a bookmark
static java.lang.String BOOKMARK_FOLDER
          a particular type of folder which usually contains bookmarks
static java.lang.String CONFERENCE
          a conference room
static java.lang.String CONTACT
          an entity that can be contacted, e.g. a user, a group, a location, ...
static java.lang.String CONTACT_FOLDER
          a particular type of folder which usually contains contacts
static java.lang.String FOLDER
          an entry which purpose is to reference other personal store entry
static java.lang.String GATEWAY
          an IM gateway.
static java.lang.String GROUP
          a group.
static java.lang.String PROFILE
          profile info - individually accessible element of application configuration information.
static java.lang.String PROFILE_FOLDER
          a particular type of folder which usually contains application profiles.
static java.lang.String WATCHER
          a watcher
 
Method Summary
 void addToFolder(PersonalStoreFolder folder)
          adds a reference to this entry in the specified folder
 java.lang.String getDisplayName()
          returns the display name
 java.lang.String getEntryId()
          returns the entry id
 java.util.Collection getFolders()
          retrieve folders in whic this entry is
 java.lang.String getType()
          returns the type of this personal store entry
 void remove()
          removes this entry from the personal store.
 void removeFromFolder(PersonalStoreFolder folder)
          removes a reference to this entry from the specified folder
 void save()
          commit the current memory image of this entry to permanent storage.
 void setDisplayName(java.lang.String name)
          sets the display name
 

Field Detail

CONTACT

public static final java.lang.String CONTACT
an entity that can be contacted, e.g. a user, a group, a location, ...

See Also:
Constant Field Values

BOOKMARK

public static final java.lang.String BOOKMARK
a bookmark

See Also:
Constant Field Values

GROUP

public static final java.lang.String GROUP
a group. Contact which lets you reach one to many users.

See Also:
Constant Field Values

CONFERENCE

public static final java.lang.String CONFERENCE
a conference room

See Also:
Constant Field Values

WATCHER

public static final java.lang.String WATCHER
a watcher

See Also:
Constant Field Values

PROFILE

public static final java.lang.String PROFILE
profile info - individually accessible element of application configuration information.

See Also:
Constant Field Values

FOLDER

public static final java.lang.String FOLDER
an entry which purpose is to reference other personal store entry

See Also:
Constant Field Values

CONTACT_FOLDER

public static final java.lang.String CONTACT_FOLDER
a particular type of folder which usually contains contacts

See Also:
Constant Field Values

BOOKMARK_FOLDER

public static final java.lang.String BOOKMARK_FOLDER
a particular type of folder which usually contains bookmarks

See Also:
Constant Field Values

PROFILE_FOLDER

public static final java.lang.String PROFILE_FOLDER
a particular type of folder which usually contains application profiles.

See Also:
Constant Field Values

GATEWAY

public static final java.lang.String GATEWAY
an IM gateway.

See Also:
Constant Field Values
Method Detail

getEntryId

public java.lang.String getEntryId()
returns the entry id

Returns:
entry id

getDisplayName

public java.lang.String getDisplayName()
returns the display name

Returns:
display name

setDisplayName

public void setDisplayName(java.lang.String name)
sets the display name

Parameters:
name - The display name to set

getType

public java.lang.String getType()
returns the type of this personal store entry


addToFolder

public void addToFolder(PersonalStoreFolder folder)
                 throws CollaborationException
adds a reference to this entry in the specified folder

Parameters:
folder - folder in which to add the entry
Throws:
CollaborationException

removeFromFolder

public void removeFromFolder(PersonalStoreFolder folder)
                      throws CollaborationException
removes a reference to this entry from the specified folder

Parameters:
folder - folder from which to remove the entry
Throws:
CollaborationException

getFolders

public java.util.Collection getFolders()
                                throws CollaborationException
retrieve folders in whic this entry is

Throws:
CollaborationException

save

public void save()
          throws CollaborationException
commit the current memory image of this entry to permanent storage.

Throws:
CollaborationException

remove

public void remove()
            throws CollaborationException
removes this entry from the personal store. This operation is committed immediately to permanent storage.

Throws:
CollaborationException