org.oscelot.lti.tp

Class User

java.lang.Object

org.oscelot.lti.tp.User

public class User
extends java.lang.Object

Class to represent an LTI User.

Version:

1.1.01 (18-Jun-13)

Author:

Stephen P Vickers

Constructor Summary

Constructors

Constructor and Description
User(ResourceLink resourceLink, java.lang.String id) Constructs a User object for the specified resource link and user ID.

Method Summary

Methods

Modifier and Type	Method and Description
void	addGroup(java.lang.String id) Add a group ID for the user.
boolean	delete() Delete the user from the database.
java.util.Calendar	getCreated() Returns the date/time when the object was created.
java.lang.String	getEmail() Returns the user's email.
java.lang.String	getFirstname() Returns the user's firstname.
java.lang.String	getFullname() Returns the user's fullname.
java.util.List<java.lang.String>	getGroups() Returns a list of group IDs for which the user is a member.
java.lang.String	getId() Return the user ID using the default scope.
java.lang.String	getId(java.lang.Integer idScope) Return the user ID using the specified scope.
java.lang.String	getLastname() Returns the user's lastname.
java.lang.String	getLtiResultSourcedId() Returns the user's result sourcedId value.
ResourceLink	getResourceLink() Return the resource link object for the user.
java.util.Calendar	getUpdated() Returns the date/time when the object was last updated.
void	initialise() Initialise the user object properties.
boolean	isAdmin() Return true if the user is an administrator.
boolean	isLearner() Return true if the user is a learner.
boolean	isStaff() Return true if the user is staff.
boolean	load() Load the user from the database.
boolean	save() Save the user to the database.
void	setCreated(java.util.Calendar created) Sets the creation date/time for the object.
void	setEmail(java.lang.String email) Set the user's email.
void	setEmail(java.lang.String email, java.lang.String defaultEmail) Set the user's email address.
void	setFirstname(java.lang.String firstname) Set the user's firstname.
void	setFullname(java.lang.String fullname) Set the user's fullname.
void	setLastname(java.lang.String lastname) Set the user's lastname.
void	setLtiResultSourcedId(java.lang.String ltiResultSourcedId) Sets the user's result sourcedId value.
void	setNames(java.lang.String firstname, java.lang.String lastname, java.lang.String fullname) Set the user's name using values for first, last and/or full names.
void	setRoles(java.util.List<java.lang.String> rolesList) Set the user's roles to those specified in the list provided.
void	setRoles(java.lang.String rolesString) Set the user's roles to those specified in the comma separated list provided.
void	setUpdated(java.util.Calendar updated) Sets the last update date/time for the object.
java.lang.String	toString() Returns a string representation of this user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

User

public User(ResourceLink resourceLink,
    java.lang.String id)

Constructs a User object for the specified resource link and user ID.

Parameters:

resourceLink - ResourceLink object

id - User ID value

Method Detail

initialise

public final void initialise()

Initialise the user object properties.

load

public final boolean load()

Load the user from the database.

Returns:

true if the user object was successfully loaded

save

public boolean save()

Save the user to the database.

Returns:

true if the user object was successfully saved

delete

public boolean delete()

Delete the user from the database.

Returns:

true if the user object was successfully deleted

getResourceLink

public ResourceLink getResourceLink()

Return the resource link object for the user.

Returns:

ResourceLink object

getId

public java.lang.String getId()

Return the user ID using the default scope.

The ID value may be a compound of the tool consumer and resource link IDs.

Returns:

User ID value

See Also:

ToolProvider.setIdScope(int)

getId

public java.lang.String getId(java.lang.Integer idScope)

Return the user ID using the specified scope.

The ID value may be a compound of the tool consumer and resource link IDs.

Returns:

User ID value

setNames

public void setNames(java.lang.String firstname,
            java.lang.String lastname,
            java.lang.String fullname)

Set the user's name using values for first, last and/or full names.

A default name based on the user's ID is generated if no values are passed.

Parameters:

firstname - User's first name.

lastname - User's last name.

fullname - User's full name.

setEmail

public void setEmail(java.lang.String email,
            java.lang.String defaultEmail)

Set the user's email address.

If the default value passed begins with @ it is prefixed with the user's ID if no email is provided.

Parameters:

email - Email address value

defaultEmail - Value to use if no email is provided

setRoles

public void setRoles(java.util.List<java.lang.String> rolesList)

Set the user's roles to those specified in the list provided.

Parameters:

rolesList - a list of role values

setRoles

public void setRoles(java.lang.String rolesString)

Set the user's roles to those specified in the comma separated list provided.

Parameters:

rolesString - a string containing a list of roles

getLtiResultSourcedId

public java.lang.String getLtiResultSourcedId()

Returns the user's result sourcedId value.

Returns:

result sourcedId

setLtiResultSourcedId

public void setLtiResultSourcedId(java.lang.String ltiResultSourcedId)

Sets the user's result sourcedId value.

Parameters:

ltiResultSourcedId - result sourcedId value

getCreated

public java.util.Calendar getCreated()

Returns the date/time when the object was created.

Returns:

date/time of creation

setCreated

public void setCreated(java.util.Calendar created)

Sets the creation date/time for the object.

Parameters:

created - date/time of creation

getUpdated

public java.util.Calendar getUpdated()

Returns the date/time when the object was last updated.

Returns:

date/time of last update

setUpdated

public void setUpdated(java.util.Calendar updated)

Sets the last update date/time for the object.

Parameters:

updated - date/time of last update

isAdmin

public boolean isAdmin()

Return true if the user is an administrator.

Returns:

true if the user has a role of administrator

isStaff

public boolean isStaff()

Return true if the user is staff.

Returns:

true if the user has a role of instructor, contentdeveloper or teachingassistant

isLearner

public boolean isLearner()

Return true if the user is a learner.

Returns:

true if the user has a role of learner

getFirstname

public java.lang.String getFirstname()

Returns the user's firstname.

Returns:

firstname

setFirstname

public void setFirstname(java.lang.String firstname)

Set the user's firstname.

Parameters:

firstname - string containing the user's firstname

See Also:

setNames(String, String, String)

getLastname

public java.lang.String getLastname()

Returns the user's lastname.

Returns:

lastname

setLastname

public void setLastname(java.lang.String lastname)

Set the user's lastname.

Parameters:

lastname - string containing the user's lastname

See Also:

setNames(String, String, String)

getFullname

public java.lang.String getFullname()

Returns the user's fullname.

Returns:

fullname

setFullname

public void setFullname(java.lang.String fullname)

Set the user's fullname.

Parameters:

fullname - string containing the user's fullname

See Also:

setNames(String, String, String)

getEmail

public java.lang.String getEmail()

Returns the user's email.

Returns:

email

setEmail

public void setEmail(java.lang.String email)

Set the user's email.

Parameters:

email - user's email address

getGroups

public java.util.List<java.lang.String> getGroups()

Returns a list of group IDs for which the user is a member.

Returns:

list of group IDs

addGroup

public void addGroup(java.lang.String id)

Add a group ID for the user.

Parameters:

id - group ID

toString

public java.lang.String toString()

Returns a string representation of this user.

The string representation consists of the user's ID, firstname, lastname, fullname, email address, result sourcedId, roles and groups.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this user