org.apache.jetspeed.om.profile
Interface Profile

All Superinterfaces:

java.lang.Cloneable, ProfileLocator, java.io.Serializable

All Known Implementing Classes:

BaseProfile, ImportProfile

public interface Profile

extends ProfileLocator

Represents a profile, the interface to a PSML resource.

Version:

$Id: Profile.java,v 1.11 2004/02/23 03:05:01 jford Exp $

Author:

David Sean Taylor

Method Summary

PSMLDocument	getDocument() Gets the psml document attached to this profile
PortletSet	getRootSet() Deprecated. Will be removed with refactoring of profiler service.
void	init(ProfileLocator locator) initialize a profile from a locator
void	setDocument(PSMLDocument document) Sets the psml document attached to this profile
void	store() stores the resource by merging and rewriting the psml file

Methods inherited from interface org.apache.jetspeed.om.profile.ProfileLocator

clone, createFromPath, getAnonymous, getCountry, getGroup, getGroupName, getId, getLanguage, getMediaType, getName, getPath, getRole, getRoleName, getUser, getUserName, setAnonymous, setCountry, setGroup, setGroupByName, setLanguage, setMediaType, setName, setRole, setRoleByName, setUser

Method Detail

getRootSet

public PortletSet getRootSet()

Deprecated. Will be removed with refactoring of profiler service.

Gets the root set of portlets for this profile object.

Returns:

The root portlet set for this profile.

getDocument

public PSMLDocument getDocument()

Gets the psml document attached to this profile

Returns:

The PSML document for this profile.

setDocument

public void setDocument(PSMLDocument document)

Sets the psml document attached to this profile

store

public void store()
           throws ProfileException

stores the resource by merging and rewriting the psml file

Throws:

ProfileException - if an error occurs storing the profile

init

public void init(ProfileLocator locator)

initialize a profile from a locator

Parameters:

locator -