com.softlayer.api.service.container.user.customer.PasswordSet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.container.user.customer;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.user.security.Question;
import java.util.ArrayList;
import java.util.List;

/**
 * Container for holding information necessary for the setting and resetting of customer passwords 
 *
 * @see SoftLayer_Container_User_Customer_PasswordSet
 */
@ApiType("SoftLayer_Container_User_Customer_PasswordSet")
public class PasswordSet extends Entity {

    /**
     * Id of SoftLayer_User_Security_Question.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long answeredSecurityQuestionId;

    public Long getAnsweredSecurityQuestionId() {
        return answeredSecurityQuestionId;
    }

    public void setAnsweredSecurityQuestionId(Long answeredSecurityQuestionId) {
        answeredSecurityQuestionIdSpecified = true;
        this.answeredSecurityQuestionId = answeredSecurityQuestionId;
    }

    protected boolean answeredSecurityQuestionIdSpecified;

    public boolean isAnsweredSecurityQuestionIdSpecified() {
        return answeredSecurityQuestionIdSpecified;
    }

    public void unsetAnsweredSecurityQuestionId() {
        answeredSecurityQuestionId = null;
        answeredSecurityQuestionIdSpecified = false;
    }

    /**
     * The authentication methods required.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected List authenticationMethods;

    public List getAuthenticationMethods() {
        if (authenticationMethods == null) {
            authenticationMethods = new ArrayList();
        }
        return authenticationMethods;
    }

    protected boolean authenticationMethodsSpecified;

    public boolean isAuthenticationMethodsSpecified() {
        return authenticationMethodsSpecified;
    }

    public void unsetAuthenticationMethods() {
        authenticationMethods = null;
        authenticationMethodsSpecified = false;
    }

    /**
     * The number of digits required.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long digitCountRequirement;

    public Long getDigitCountRequirement() {
        return digitCountRequirement;
    }

    public void setDigitCountRequirement(Long digitCountRequirement) {
        digitCountRequirementSpecified = true;
        this.digitCountRequirement = digitCountRequirement;
    }

    protected boolean digitCountRequirementSpecified;

    public boolean isDigitCountRequirementSpecified() {
        return digitCountRequirementSpecified;
    }

    public void unsetDigitCountRequirement() {
        digitCountRequirement = null;
        digitCountRequirementSpecified = false;
    }

    /**
     * The password key provided to user in the password set url link sent via email. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String key;

    public String getKey() {
        return key;
    }

    public void setKey(String key) {
        keySpecified = true;
        this.key = key;
    }

    protected boolean keySpecified;

    public boolean isKeySpecified() {
        return keySpecified;
    }

    public void unsetKey() {
        key = null;
        keySpecified = false;
    }

    /**
     * The number of lowercase letters required.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long lowercaseCountRequirement;

    public Long getLowercaseCountRequirement() {
        return lowercaseCountRequirement;
    }

    public void setLowercaseCountRequirement(Long lowercaseCountRequirement) {
        lowercaseCountRequirementSpecified = true;
        this.lowercaseCountRequirement = lowercaseCountRequirement;
    }

    protected boolean lowercaseCountRequirementSpecified;

    public boolean isLowercaseCountRequirementSpecified() {
        return lowercaseCountRequirementSpecified;
    }

    public void unsetLowercaseCountRequirement() {
        lowercaseCountRequirement = null;
        lowercaseCountRequirementSpecified = false;
    }

    /**
     * The maximum password length requirement.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long maximumPasswordLengthRequirement;

    public Long getMaximumPasswordLengthRequirement() {
        return maximumPasswordLengthRequirement;
    }

    public void setMaximumPasswordLengthRequirement(Long maximumPasswordLengthRequirement) {
        maximumPasswordLengthRequirementSpecified = true;
        this.maximumPasswordLengthRequirement = maximumPasswordLengthRequirement;
    }

    protected boolean maximumPasswordLengthRequirementSpecified;

    public boolean isMaximumPasswordLengthRequirementSpecified() {
        return maximumPasswordLengthRequirementSpecified;
    }

    public void unsetMaximumPasswordLengthRequirement() {
        maximumPasswordLengthRequirement = null;
        maximumPasswordLengthRequirementSpecified = false;
    }

    /**
     * The minimum password length requirement.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long minimumPasswordLengthRequirement;

    public Long getMinimumPasswordLengthRequirement() {
        return minimumPasswordLengthRequirement;
    }

    public void setMinimumPasswordLengthRequirement(Long minimumPasswordLengthRequirement) {
        minimumPasswordLengthRequirementSpecified = true;
        this.minimumPasswordLengthRequirement = minimumPasswordLengthRequirement;
    }

    protected boolean minimumPasswordLengthRequirementSpecified;

    public boolean isMinimumPasswordLengthRequirementSpecified() {
        return minimumPasswordLengthRequirementSpecified;
    }

    public void unsetMinimumPasswordLengthRequirement() {
        minimumPasswordLengthRequirement = null;
        minimumPasswordLengthRequirementSpecified = false;
    }

    /**
     * The user's new password.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String password;

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        passwordSpecified = true;
        this.password = password;
    }

    protected boolean passwordSpecified;

    public boolean isPasswordSpecified() {
        return passwordSpecified;
    }

    public void unsetPassword() {
        password = null;
        passwordSpecified = false;
    }

    /**
     * Answer to security question provided by the user.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String securityAnswer;

    public String getSecurityAnswer() {
        return securityAnswer;
    }

    public void setSecurityAnswer(String securityAnswer) {
        securityAnswerSpecified = true;
        this.securityAnswer = securityAnswer;
    }

    protected boolean securityAnswerSpecified;

    public boolean isSecurityAnswerSpecified() {
        return securityAnswerSpecified;
    }

    public void unsetSecurityAnswer() {
        securityAnswer = null;
        securityAnswerSpecified = false;
    }

    /**
     * Array of SoftLayer_User_Security_Question.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected List securityQuestions;

    public List getSecurityQuestions() {
        if (securityQuestions == null) {
            securityQuestions = new ArrayList();
        }
        return securityQuestions;
    }

    protected boolean securityQuestionsSpecified;

    public boolean isSecurityQuestionsSpecified() {
        return securityQuestionsSpecified;
    }

    public void unsetSecurityQuestions() {
        securityQuestions = null;
        securityQuestionsSpecified = false;
    }

    /**
     * The number of special characters required.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long specialCharacterCountRequirement;

    public Long getSpecialCharacterCountRequirement() {
        return specialCharacterCountRequirement;
    }

    public void setSpecialCharacterCountRequirement(Long specialCharacterCountRequirement) {
        specialCharacterCountRequirementSpecified = true;
        this.specialCharacterCountRequirement = specialCharacterCountRequirement;
    }

    protected boolean specialCharacterCountRequirementSpecified;

    public boolean isSpecialCharacterCountRequirementSpecified() {
        return specialCharacterCountRequirementSpecified;
    }

    public void unsetSpecialCharacterCountRequirement() {
        specialCharacterCountRequirement = null;
        specialCharacterCountRequirementSpecified = false;
    }

    /**
     * List of the allowed special characters.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String specialCharactersAllowed;

    public String getSpecialCharactersAllowed() {
        return specialCharactersAllowed;
    }

    public void setSpecialCharactersAllowed(String specialCharactersAllowed) {
        specialCharactersAllowedSpecified = true;
        this.specialCharactersAllowed = specialCharactersAllowed;
    }

    protected boolean specialCharactersAllowedSpecified;

    public boolean isSpecialCharactersAllowedSpecified() {
        return specialCharactersAllowedSpecified;
    }

    public void unsetSpecialCharactersAllowed() {
        specialCharactersAllowed = null;
        specialCharactersAllowedSpecified = false;
    }

    /**
     * The number of uppercase letters required.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long uppercaseCountRequirement;

    public Long getUppercaseCountRequirement() {
        return uppercaseCountRequirement;
    }

    public void setUppercaseCountRequirement(Long uppercaseCountRequirement) {
        uppercaseCountRequirementSpecified = true;
        this.uppercaseCountRequirement = uppercaseCountRequirement;
    }

    protected boolean uppercaseCountRequirementSpecified;

    public boolean isUppercaseCountRequirementSpecified() {
        return uppercaseCountRequirementSpecified;
    }

    public void unsetUppercaseCountRequirement() {
        uppercaseCountRequirement = null;
        uppercaseCountRequirementSpecified = false;
    }

    /**
     * The id of the user to authenticate.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long userId;

    public Long getUserId() {
        return userId;
    }

    public void setUserId(Long userId) {
        userIdSpecified = true;
        this.userId = userId;
    }

    protected boolean userIdSpecified;

    public boolean isUserIdSpecified() {
        return userIdSpecified;
    }

    public void unsetUserId() {
        userId = null;
        userIdSpecified = false;
    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public Mask answeredSecurityQuestionId() {
            withLocalProperty("answeredSecurityQuestionId");
            return this;
        }

        public Mask authenticationMethods() {
            withLocalProperty("authenticationMethods");
            return this;
        }

        public Mask digitCountRequirement() {
            withLocalProperty("digitCountRequirement");
            return this;
        }

        public Mask key() {
            withLocalProperty("key");
            return this;
        }

        public Mask lowercaseCountRequirement() {
            withLocalProperty("lowercaseCountRequirement");
            return this;
        }

        public Mask maximumPasswordLengthRequirement() {
            withLocalProperty("maximumPasswordLengthRequirement");
            return this;
        }

        public Mask minimumPasswordLengthRequirement() {
            withLocalProperty("minimumPasswordLengthRequirement");
            return this;
        }

        public Mask password() {
            withLocalProperty("password");
            return this;
        }

        public Mask securityAnswer() {
            withLocalProperty("securityAnswer");
            return this;
        }

        public com.softlayer.api.service.user.security.Question.Mask securityQuestions() {
            return withSubMask("securityQuestions", com.softlayer.api.service.user.security.Question.Mask.class);
        }

        public Mask specialCharacterCountRequirement() {
            withLocalProperty("specialCharacterCountRequirement");
            return this;
        }

        public Mask specialCharactersAllowed() {
            withLocalProperty("specialCharactersAllowed");
            return this;
        }

        public Mask uppercaseCountRequirement() {
            withLocalProperty("uppercaseCountRequirement");
            return this;
        }

        public Mask userId() {
            withLocalProperty("userId");
            return this;
        }

    }

}