Package com.softlayer.api.service

Interface Survey.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Survey

@ApiService("SoftLayer_Survey")
public static interface Survey.Service
extends Service

Every SoftLayer survey is defined in the SoftLayer_Survey service. Softlayer survey's have questions and answers from SoftLayer users.

See Also:

SoftLayer_Survey

Method Summary

Modifier and Type	Method	Description
Survey.ServiceAsync	asAsync()	Get an async version of this service
Survey	getActiveSurveyByType(String type)	Provides survey details for the given type
Survey	getObject()	getObject retrieves the SoftLayer_Survey object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Survey service.
List<Question>	getQuestions()	The questions for a survey.
Status	getStatus()	The status of the survey
Type	getType()	The type of survey
void	setMask(Survey.Mask mask)
Boolean	takeSurvey(List<Response> responses)	Response to a SoftLayer survey's questions.
Survey.Mask	withMask()	Use the existing mask on this service or create it if not present
Survey.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Detail

asAsync

Survey.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Survey.Mask withNewMask()

Description copied from interface: Maskable

Overwrite the existing mask on this service with a new one and return it

Specified by:

withNewMask in interface Maskable

withMask

Survey.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(Survey.Mask mask)

getActiveSurveyByType

@ApiMethod
Survey getActiveSurveyByType(String type)

Provides survey details for the given type

See Also:

SoftLayer_Survey::getActiveSurveyByType

getObject

@ApiMethod(instanceRequired=true)
Survey getObject()

getObject retrieves the SoftLayer_Survey object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Survey service. You can only retrieve the survey that your portal user has taken.

See Also:

SoftLayer_Survey::getObject

takeSurvey

@ApiMethod(instanceRequired=true)
Boolean takeSurvey(List<Response> responses)

Response to a SoftLayer survey's questions.

See Also:

SoftLayer_Survey::takeSurvey

getQuestions

@ApiMethod(instanceRequired=true)
List<Question> getQuestions()

The questions for a survey.

See Also:

SoftLayer_Survey::getQuestions

getStatus

@ApiMethod(instanceRequired=true)
Status getStatus()

The status of the survey

See Also:

SoftLayer_Survey::getStatus

getType

@ApiMethod(instanceRequired=true)
Type getType()

The type of survey

See Also:

SoftLayer_Survey::getType