org.sakaiproject.signup.logic.SignupUser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of signup-api Show documentation
There is a newer version: 23.3
/**
 * Copyright (c) 2007-2014 The Apereo Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *             http://opensource.org/licenses/ecl2
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
* Licensed to The Apereo Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*
* The Apereo Foundation licenses this file to you under the Educational 
* Community License, Version 2.0 (the "License"); you may not use this file 
* except in compliance with the License. You may obtain a copy of the 
* License at:
*
* http://opensource.org/licenses/ecl2.txt
* 
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.sakaiproject.signup.logic;

import org.apache.commons.lang3.StringUtils;
import org.sakaiproject.authz.api.Role;

/**
 * 
 * This class is a place holder, which contains all the user necessary
 * informaion for Signup Tool
 * 
 */
public class SignupUser {

	private String eid;

	private String internalUserId;

	private String firstName;

	private String lastName;

	private Role userRole;
	
	private String mainSiteId;
	
	private boolean publishedSite;
	
	private boolean checked;

	/**
	 * Construtor
	 * 
	 * @param eid
	 *            an unique Sakai enterprise Id(UserId for UI)
	 * @param internalUserId
	 *            an unique Sakai internal used Id(not UserId)
	 * @param firstName
	 *            First Name of the user
	 * @param lastName
	 *            Last Name of the user
	 * @param role
	 *            a Sakai Role object
	 */
	public SignupUser(String eid, String internalUserId, String firstName, String lastName, Role role,String siteId,boolean publishedSite) {
		this.eid = eid;
		this.internalUserId = internalUserId;
		this.firstName = firstName;
		this.lastName = firstCharToUppercase(lastName);
		this.userRole = role;
		this.mainSiteId = siteId;
		this.publishedSite = publishedSite;
		if((this.lastName ==null || this.lastName.trim().length()==0) 
			&& (this.firstName ==null || this.firstName.trim().length()==0)){
			this.lastName = eid;
		}

	}

	/**
	 * get Sakai Enterprise Id
	 * 
	 * @return a unique eid
	 */
	public String getEid() {
		return eid;
	}

	/**
	 * get a unique Sakai internal used Id
	 * 
	 * @return a unique Sakai internal used Id
	 */
	public String getInternalUserId() {
		return internalUserId;
	}

	/**
	 * check to see if the objects are equal
	 */
	public boolean equals(Object other) {
		if (other == null || !(other instanceof SignupUser))
			return false;
		SignupUser user = (SignupUser) other;

		return eid.equals(user.getEid());
	}

	public int hashCode() {
		return eid.hashCode();
	}

	/**
	 * get first name of the user
	 * 
	 * @return the first name of the user
	 */
	public String getFirstName() {
		return firstName;
	}

	/**
	 * get the last name of the user
	 * 
	 * @return the last name of the user
	 */
	public String getLastName() {
		return lastName;
	}

	/**
	 * get the display name: order of 'last name, first name'
	 * 
	 * @return the display name
	 */
	public String getDisplayName() {
		String name = lastName + ", " + ((firstName != null) ? firstName : "");
		if (name.trim().length()==1)//just ',' character
			name = eid;
		return name;
	}

	/**
	 * get the user Sakai Role object
	 * 
	 * @return the Sakai user Role object
	 */
	public Role getUserRole() {
		return userRole;
	}

	/**
	 * set the user Role object
	 * 
	 * @param userRole
	 *            the user Sakai Role object
	 */
	public void setUserRole(Role userRole) {
		this.userRole = userRole;
	}		

	public String getMainSiteId() {
		return mainSiteId;
	}

	public void setMainSiteId(String mainSiteId) {
		this.mainSiteId = mainSiteId;
	}

	public boolean isPublishedSite() {
		return publishedSite;
	}

	public void setPublishedSite(boolean publishedSite) {
		this.publishedSite = publishedSite;
	}

	private String firstCharToUppercase(String name) {
		if (name != null && name.length() > 0)
			return name.substring(0, 1).toUpperCase() + name.substring(1);

		return name;
	}

	public boolean isChecked() {
		return checked;
	}

	public void setChecked(boolean checked) {
		this.checked = checked;
	}

}