org.netbeans.lib.collab
Interface PersonalStoreFolder

All Superinterfaces:
PersonalStoreEntry

public interface PersonalStoreFolder
extends PersonalStoreEntry

A folder is an entry which can contain other entries

Since:
version 0.1

Field Summary
 
Fields inherited from interface org.netbeans.lib.collab.PersonalStoreEntry
BOOKMARK, BOOKMARK_FOLDER, CONFERENCE, CONTACT, CONTACT_FOLDER, FOLDER, GATEWAY, GROUP, PROFILE, PROFILE_FOLDER, WATCHER
 
Method Summary
 java.util.Collection getEntries()
          returns all entries in this folder
 java.util.Collection getEntries(java.lang.String entryType)
          returns all entries of a specified type
 PersonalStoreEntry getEntry(java.lang.String entryId)
          returns a specific entry referenced in this folder
 boolean hasEntry(java.lang.String entryId)
          returns true is the specified entry is in this folder
 void rename(java.lang.String displayName)
          rename the display name for this folder
 int size()
          returns the number of entries in the folder
 
Methods inherited from interface org.netbeans.lib.collab.PersonalStoreEntry
addToFolder, getDisplayName, getEntryId, getFolders, getType, remove, removeFromFolder, save, setDisplayName
 

Method Detail

size

public int size()
returns the number of entries in the folder


getEntries

public java.util.Collection getEntries()
                                throws CollaborationException
returns all entries in this folder

Throws:
CollaborationException

getEntries

public java.util.Collection getEntries(java.lang.String entryType)
                                throws CollaborationException
returns all entries of a specified type

Parameters:
entryType - the type for filter on
Throws:
CollaborationException

getEntry

public PersonalStoreEntry getEntry(java.lang.String entryId)
                            throws CollaborationException
returns a specific entry referenced in this folder

Parameters:
entryId - ID of the entry to retrieve.
Throws:
CollaborationException

hasEntry

public boolean hasEntry(java.lang.String entryId)
returns true is the specified entry is in this folder

Parameters:
entryId - ID of the entry to retrieve.

rename

public void rename(java.lang.String displayName)
rename the display name for this folder

Parameters:
displayName - new display name for this folder