Package com.softlayer.api.service.layout

Interface Profile.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

All Known Subinterfaces:

Customer.Service

Enclosing class:

Profile

@ApiService("SoftLayer_Layout_Profile")
public static interface Profile.Service
extends Service

Layout profiles are the primary object used to tie customized portal experiences to the [[SoftLayer_User_Customer|user account]].

In order to take full advantage of the flexible customization of the portal, each user must be given one or more layout profiles. Each layout profile is then assigned one of the [[SoftLayer_Layout_Container|layout containers]], thereby giving the user all [[SoftLayer_Layout_Item|items]] and associated [[SoftLayer_Layout_Profile_Preferences|default preferences]]. These default preferences can be modified via the [[SoftLayer_Layout_Profile::modifyPreference()]] method, giving the user their own customized configuration.

See Also:

SoftLayer_Layout_Profile

Method Summary

Modifier and Type	Method	Description
Profile.ServiceAsync	asAsync()	Get an async version of this service
Boolean	createObject(Profile templateObject)	This method creates a new layout profile object.
Boolean	deleteObject()	This method deletes an existing layout profile and associated custom preferences
Boolean	editObject(Profile templateObject)	This method edits an existing layout profile object by passing in a modified instance of the object.
List<Container>	getLayoutContainers()
List<Preference>	getLayoutPreferences()
Profile	getObject()
Preference	modifyPreference(Preference templateObject)	This method modifies an existing associated [[SoftLayer_Layout_Profile_Preference]] object.
List<Preference>	modifyPreferences(List<Preference> layoutPreferenceObjects)	Using this method, multiple [[SoftLayer_Layout_Profile_Preference]] objects may be updated at once.
void	setMask(Profile.Mask mask)
Profile.Mask	withMask()	Use the existing mask on this service or create it if not present
Profile.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

Profile.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Profile.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

Profile.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(Profile.Mask mask)

createObject

@ApiMethod
Boolean createObject(Profile templateObject)

This method creates a new layout profile object.

See Also:

SoftLayer_Layout_Profile::createObject

deleteObject

@ApiMethod(instanceRequired=true)
Boolean deleteObject()

This method deletes an existing layout profile and associated custom preferences

See Also:

SoftLayer_Layout_Profile::deleteObject

editObject

@ApiMethod(instanceRequired=true)
Boolean editObject(Profile templateObject)

This method edits an existing layout profile object by passing in a modified instance of the object.

See Also:

SoftLayer_Layout_Profile::editObject

getObject

@ApiMethod(instanceRequired=true)
Profile getObject()

See Also:

SoftLayer_Layout_Profile::getObject

modifyPreference

@ApiMethod(instanceRequired=true)
Preference modifyPreference(Preference templateObject)

This method modifies an existing associated [[SoftLayer_Layout_Profile_Preference]] object. If the preference object being modified is a default value object, a new record is created to override the default value.

Only preferences that are assigned to a profile may be updated. Attempts to update a non-existent preference object will result in an exception being thrown.

See Also:

SoftLayer_Layout_Profile::modifyPreference

modifyPreferences

@ApiMethod(instanceRequired=true)
List<Preference> modifyPreferences(List<Preference> layoutPreferenceObjects)

Using this method, multiple [[SoftLayer_Layout_Profile_Preference]] objects may be updated at once.

Refer to [[SoftLayer_Layout_Profile::modifyPreference()]] for more information.

See Also:

SoftLayer_Layout_Profile::modifyPreferences

getLayoutContainers

@ApiMethod(instanceRequired=true)
List<Container> getLayoutContainers()

See Also:

SoftLayer_Layout_Profile::getLayoutContainers

getLayoutPreferences

@ApiMethod(instanceRequired=true)
List<Preference> getLayoutPreferences()

See Also:

SoftLayer_Layout_Profile::getLayoutPreferences