org.sakaiproject.tool.assessment.integration.helper.ifc
Interface AgentHelper

All Superinterfaces:
Serializable
All Known Implementing Classes:
AgentHelperImpl, AgentHelperImpl

public interface AgentHelper
extends Serializable

Description: This is a context implementation helper delegate interface for the AgentFacade class. Using Spring injection via the integrationContext.xml selected by the build process to find the implementation.

Sakai Project Copyright (c) 2005

Author:
Ed Smiley

Field Summary
static String UNASSIGNED_AGENT_STRING
           
 
Method Summary
 String createAnonymous(AgentFacade agent)
           
 AgentImpl getAgent()
           
 String getAgentString(String agentString)
           
 String getAnonymousId(String agentString)
           
 String getCurrentSiteId(boolean accessViaUrl)
           
 String getCurrentSiteName(boolean accessViaUrl)
           
 String getDisplayName(String agentString)
           
 String getDisplayNameByAgentId(String agentId)
           
 String getFirstName(String agentString)
           
 String getLastName(String agentString)
           
 String getRole(String agentString)
           
 String getRoleForAgentAndSite(String agentString, String siteId)
           
 String getRoleForCurrentAgent(String agentString)
           
 String getSiteName(String siteId)
           
 Map getUserRolesFromContextRealm(Collection inUsers)
           
 boolean isFileUploadAvailable()
          Deprecated.  
 boolean isIntegratedEnvironment()
           
 boolean isStandaloneEnvironment()
           
 

Field Detail

UNASSIGNED_AGENT_STRING

public static final String UNASSIGNED_AGENT_STRING
See Also:
Constant Field Values
Method Detail

getAgent

public AgentImpl getAgent()

getAgentString

public String getAgentString(String agentString)

createAnonymous

public String createAnonymous(AgentFacade agent)

getAnonymousId

public String getAnonymousId(String agentString)

getDisplayName

public String getDisplayName(String agentString)

getFirstName

public String getFirstName(String agentString)

getLastName

public String getLastName(String agentString)

getRole

public String getRole(String agentString)

getRoleForCurrentAgent

public String getRoleForCurrentAgent(String agentString)

getCurrentSiteId

public String getCurrentSiteId(boolean accessViaUrl)

getCurrentSiteName

public String getCurrentSiteName(boolean accessViaUrl)

getSiteName

public String getSiteName(String siteId)

getDisplayNameByAgentId

public String getDisplayNameByAgentId(String agentId)

isStandaloneEnvironment

public boolean isStandaloneEnvironment()

isIntegratedEnvironment

public boolean isIntegratedEnvironment()

getUserRolesFromContextRealm

public Map getUserRolesFromContextRealm(Collection inUsers)

getRoleForAgentAndSite

public String getRoleForAgentAndSite(String agentString,
                                     String siteId)

isFileUploadAvailable

public boolean isFileUploadAvailable()
Deprecated.  

This is a kludge to work around a JSF scriptlet dependency introduced by cwen on org.sakaiproject.service.framework.config.cover.ServerConfigurationService.

Returns:
true unless it is turned off