org.sakaiproject.api.common.agent
Interface Agent

All Superinterfaces:
Persistable, Typeable
All Known Subinterfaces:
Group
All Known Implementing Classes:
AgentBean, AgentUserProxy, GroupBean

public interface Agent
extends Persistable, Typeable

Agent is a very abstract notion of what would be considered an "Actor". An Agent could be a person, a machine, or some application for example. Another way to think about Agent is that it would be analogous to a security principal. Agents are one of the fundamental pieces of authorization. They are one of the targets to which permissions are assigned.

Since:
Sakai 2.0
Version:
$Id: Agent.java 632 2005-07-14 21:22:50Z janderse@umich.edu $
Author:
Lance Speelmon

Method Summary
 String getDisplayName()
           
 String getEnterpriseId()
          The local institution unique id (e.g. kerberos name, etc.)
 String getSessionManagerUserId()
          The unique id generated by SessionManager.
 String getSortName()
          All sorting of Agents should be performed on this representation of the object.
 void setDisplayName(String displayName)
           
 void setEnterpriseId(String enterpriseId)
          The local institution unique id (e.g. kerberos name, etc.)
 void setSessionManagerUserId(String sessionManagerUserId)
           
 void setSortName(String sortName)
          All sorting of Agents should be performed on this representation of the object.
 
Methods inherited from interface org.sakaiproject.api.common.manager.Persistable
getCreatedBy, getCreatedDate, getLastModifiedBy, getLastModifiedDate, getUuid
 
Methods inherited from interface org.sakaiproject.api.common.type.Typeable
getType, setType
 

Method Detail

getSessionManagerUserId

public String getSessionManagerUserId()
The unique id generated by SessionManager.

Returns:

setSessionManagerUserId

public void setSessionManagerUserId(String sessionManagerUserId)
Parameters:
sessionManagerUserId - The unique id generated by SessionManager.

getEnterpriseId

public String getEnterpriseId()
The local institution unique id (e.g. kerberos name, etc.)

Returns:

setEnterpriseId

public void setEnterpriseId(String enterpriseId)
The local institution unique id (e.g. kerberos name, etc.)

Parameters:
enterpriseId -

getDisplayName

public String getDisplayName()
Returns:
Returns the displayName.

setDisplayName

public void setDisplayName(String displayName)
Parameters:
displayName - The displayName to set.

getSortName

public String getSortName()
All sorting of Agents should be performed on this representation of the object.

Returns:

setSortName

public void setSortName(String sortName)
All sorting of Agents should be performed on this representation of the object.

Parameters:
sortName -