com.softlayer.api.service.user.security.Question 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.user.security;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_User_Security_Question data type contains questions. 
 *
 * @see SoftLayer_User_Security_Question
 */
@ApiType("SoftLayer_User_Security_Question")
public class Question extends Entity {

    /**
     * A security question's display order.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long displayOrder;

    public Long getDisplayOrder() {
        return displayOrder;
    }

    public void setDisplayOrder(Long displayOrder) {
        displayOrderSpecified = true;
        this.displayOrder = displayOrder;
    }

    protected boolean displayOrderSpecified;

    public boolean isDisplayOrderSpecified() {
        return displayOrderSpecified;
    }

    public void unsetDisplayOrder() {
        displayOrder = null;
        displayOrderSpecified = false;
    }

    /**
     * A security question's internal identifying number.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * A security question's question.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String question;

    public String getQuestion() {
        return question;
    }

    public void setQuestion(String question) {
        questionSpecified = true;
        this.question = question;
    }

    protected boolean questionSpecified;

    public boolean isQuestionSpecified() {
        return questionSpecified;
    }

    public void unsetQuestion() {
        question = null;
        questionSpecified = false;
    }

    /**
     * A security question's viewable flag.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long viewable;

    public Long getViewable() {
        return viewable;
    }

    public void setViewable(Long viewable) {
        viewableSpecified = true;
        this.viewable = viewable;
    }

    protected boolean viewableSpecified;

    public boolean isViewableSpecified() {
        return viewableSpecified;
    }

    public void unsetViewable() {
        viewable = null;
        viewableSpecified = false;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    /**
     * Every user has an option of a secondary security login feature. This SoftLayer_User_Security_Question service provides a list of security questions. 
     *
     * @see SoftLayer_User_Security_Question
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_User_Security_Question")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Retrieve all viewable security questions.
         *
         * @see SoftLayer_User_Security_Question::getAllObjects
         */
        @ApiMethod
        public List getAllObjects();

        /**
         * getAllObjects retrieves all the SoftLayer_User_Security_Question objects where it is set to be viewable. 
         *
         * @see SoftLayer_User_Security_Question::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Question getObject();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#getAllObjects}
         */
        public Future> getAllObjects();

        public Future getAllObjects(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

    }

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

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

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

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

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

    }

}