Package com.softlayer.api.service.layout

Interface Container.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Container

@ApiService("SoftLayer_Layout_Container")
public static interface Container.Service
extends Service

Layout containers are used in the customization of the Portal 4 customer experience.

A single page in the portal can be thought of as a layout container. The container houses individual [[SoftLayer_Layout_Item|layout items]], which are the elements of the page (e.g., Ticket list). Layout containers can be added to [[SoftLayer_Layout_Profile|layout profiles]], allowing for full customization of the container's related items.

See Also:

SoftLayer_Layout_Container

Method Summary

Modifier and Type	Method	Description
Container.ServiceAsync	asAsync()	Get an async version of this service
List<Container>	getAllObjects()	Use this method to retrieve all active layout containers that can be customized.
Type	getLayoutContainerType()	The type of the layout container object
List<Item>	getLayoutItems()	The layout items assigned to this layout container
Container	getObject()
void	setMask(Container.Mask mask)
Container.Mask	withMask()	Use the existing mask on this service or create it if not present
Container.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 Details

asAsync

Container.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

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

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

getAllObjects

@ApiMethod
List<Container> getAllObjects()

Use this method to retrieve all active layout containers that can be customized.

See Also:

SoftLayer_Layout_Container::getAllObjects

getObject

@ApiMethod(instanceRequired=true)
Container getObject()

See Also:

SoftLayer_Layout_Container::getObject

getLayoutContainerType

@ApiMethod(instanceRequired=true)
Type getLayoutContainerType()

The type of the layout container object

See Also:

SoftLayer_Layout_Container::getLayoutContainerType

getLayoutItems

@ApiMethod(instanceRequired=true)
List<Item> getLayoutItems()

The layout items assigned to this layout container

See Also:

SoftLayer_Layout_Container::getLayoutItems