edu.internet2.middleware.grouper.ui
Interface PersonalStem


public interface PersonalStem

Pluggable interface thats allows site-specific rules for naming Personal stems. To use this feature, the key plugin.personalstem in resources/media.properties must be set to the name of a Class which implements this interface

Version:
$Id: PersonalStem.java,v 1.4 2007-04-11 08:19:24 isgwb Exp $
Author:
Gary Brown.

Method Summary
 String getPersonalStemDescription(Subject subject)
           
 String getPersonalStemDisplayName(Subject subject)
           
 String getPersonalStemId(Subject subject)
           
 String getPersonalStemRoot(Subject subject)
           
 

Method Detail

getPersonalStemRoot

String getPersonalStemRoot(Subject subject)
                           throws Exception
Parameters:
subject - owner of personal stem
Returns:
name of stem where personal stems are located
Throws:
Exception

getPersonalStemId

String getPersonalStemId(Subject subject)
                         throws Exception
Parameters:
subject - owner of personal stem
Returns:
id - extension of personal stem
Throws:
Exception

getPersonalStemDisplayName

String getPersonalStemDisplayName(Subject subject)
                                  throws Exception
Parameters:
subject - owner of personal stem
Returns:
displayName - displayExtension of personal stem
Throws:
Exception

getPersonalStemDescription

String getPersonalStemDescription(Subject subject)
                                  throws Exception
Parameters:
subject - owner of personal stem
Returns:
description of personal stem
Throws:
Exception