com.sun.n1.sps.model.folder
Interface SummaryFolder

All Known Subinterfaces:

Folder

public interface SummaryFolder

A summary view of a Folder object.

Method Summary

java.lang.String	getDescription() Returns the description of this folder.
java.lang.String	getFullPathString() Returns the full path of this folder, including the folder name.
GroupID	getGroupID() Returns a folder owner's GroupID.
FolderID	getID() Returns the ID of this folder.
java.lang.String	getName() Returns the name of this folder.
FolderID	getParentFolderID() Returns the ID of the parent of this folder.
PluginID	getPluginID()

Method Detail

getID

FolderID getID()

Returns the ID of this folder.

Returns:

The folder ID.

getGroupID

GroupID getGroupID()

Returns a folder owner's GroupID. The return value varies based on the status of the folder.

Returns:

The GroupID associated with this folder.

getPluginID

PluginID getPluginID()

Returns:

The PluginID associated with this folder. May return null.

getParentFolderID

FolderID getParentFolderID()

Returns the ID of the parent of this folder.

Returns:

The ID of the parent of this folder, or null if this folder ID is the root folder ID..

getFullPathString

java.lang.String getFullPathString()

Returns the full path of this folder, including the folder name.

The result begins and ends with a separator. All separators are forward slashes.

If the result is the root path, the return consists simply of a single separator.

Returns:

The full path of this folder as noted above.

getName

java.lang.String getName()

Returns the name of this folder.

Returns:

The name of this folder.

getDescription

java.lang.String getDescription()

Returns the description of this folder.

Returns:

The description of this folder.