com.smartsheet.api.models.GroupMember Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smartsheet-sdk-java Show documentation
Library for connecting to Smartsheet Services
There is a newer version: 3.2.1
/*
 * Copyright (C) 2023 Smartsheet
 *
 * Licensed under the Apache 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://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 com.smartsheet.api.models;

/**
 * Represents the Group Member object.
 * @see Help
 * Managing Groups
 */
public class GroupMember extends UserModelWithName {

    /**
     * Represents the Group Member’s email address
     */
    private String email;

    /**
     * Represents the Group Member’s first name
     */
    private String firstName;

    /**
     * Represents the Group Member’s last name
     */
    private String lastName;

    /**
     * Gets the Group Member’s email address
     *
     * @return the email
     */
    public String getEmail() {
        return email;
    }

    /**
     * @param email the group member's email address to set
     */
    public UserModel setEmail(String email) {
        this.email = email;
        return null;
    }

    /**
     * Gets the Group Member’s first name
     *
     * @return the firstname
     */
    public String getFirstName() {
        return firstName;
    }

    /**
     * @param firstName the Group Member's first name to set
     */
    public UserModel setFirstName(String firstName) {
        this.firstName = firstName;
        return null;
    }

    /**
     * Gets the Group Member’s last name
     *
     * @return the last name
     */
    public String getLastName() {
        return lastName;
    }

    /**
     * @param lastName the Group Member’s last name to set
     */
    public UserModel setLastName(String lastName) {
        this.lastName = lastName;
        return null;
    }

    /**
     * A convenience class for making a {@link GroupMember} object with the appropriate fields for adding to a {@link Group}.
     */
    public static class AddGroupMemberBuilder {
        private String email;

        /**
         * Get the email of the group member
         * @return the email
         */
        public String getEmail() {
            return email;
        }

        /**
         * Set the id of the group member
         * @param email the email
         * @return the builder
         */
        public AddGroupMemberBuilder setEmail(String email) {
            this.email = email;
            return this;
        }

        /**
         * Build a GroupMember
         */
        public GroupMember build() {
            if (email == null) {
                throw new InstantiationError("An email address must be set.");
            }

            GroupMember groupMember = new GroupMember();
            groupMember.setEmail(email);
            return groupMember;
        }
    }
}