io.sphere.sdk.types.commands

Interface TypeUpdateCommand

All Superinterfaces:

Command<Type>, ExpansionPathContainer<Type>, MetaModelReferenceExpansionDsl<Type,TypeUpdateCommand,TypeExpansionModel<Type>>, ReferenceExpansionDsl<Type,TypeUpdateCommand>, ReferenceExpansionSupport<Type>, SphereRequest<Type>, UpdateCommand<Type>, UpdateCommandDsl<Type,TypeUpdateCommand>

public interface TypeUpdateCommand
extends UpdateCommandDsl<Type,TypeUpdateCommand>, MetaModelReferenceExpansionDsl<Type,TypeUpdateCommand,TypeExpansionModel<Type>>

Command object to update a Type.

Known UpdateActions

• AddEnumValue
• AddFieldDefinition
• AddLocalizedEnumValue
• ChangeEnumValueLabel
• ChangeEnumValueOrder
• ChangeFieldDefinitionLabel
• ChangeFieldDefinitionOrder
• ChangeInputHint
• ChangeKey
• ChangeLocalizedEnumValueLabel
• ChangeLocalizedEnumValueOrder
• ChangeName
• RemoveFieldDefinition
• SetDescription

See Also:

Type

Method Summary

Modifier and Type	Method and Description
static TypeUpdateCommand	of(Versioned<Type> versioned, List<? extends UpdateAction<Type>> updateActions) Creates a command to update a Type selected by its ID using several update actions.
static TypeUpdateCommand	of(Versioned<Type> versioned, UpdateAction<Type> updateAction, UpdateAction<Type>... updateActions) Creates a command to update a Type selected by its ID using one update action.
static TypeUpdateCommand	ofKey(String key, Long version, List<? extends UpdateAction<Type>> updateActions) Creates a command to update a Type selected by its key using several update actions.
static TypeUpdateCommand	ofKey(String key, Long version, UpdateAction<Type> updateAction) Creates a command to update a Type selected by its key using one update action.

Methods inherited from interface io.sphere.sdk.commands.UpdateCommandDsl

plusUpdateActions, withAdditionalHttpQueryParameters, withUpdateActions, withVersion, withVersion

Methods inherited from interface io.sphere.sdk.commands.UpdateCommand

getUpdateActions

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize, deserialize, httpRequestIntent

Methods inherited from interface io.sphere.sdk.expansion.MetaModelReferenceExpansionDsl

plusExpansionPaths, withExpansionPaths

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionDsl

plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionSupport

expansionPaths

Method Detail

of

static TypeUpdateCommand of(Versioned<Type> versioned,
                            List<? extends UpdateAction<Type>> updateActions)

Creates a command to update a Type selected by its ID using several update actions.

Parameters:

versioned - the object to update (so directly a Type) or just the version/ID information of it

updateActions - the updates

Returns:

the update command for Type

of

@SafeVarargs
static TypeUpdateCommand of(Versioned<Type> versioned,
                                         UpdateAction<Type> updateAction,
                                         UpdateAction<Type>... updateActions)

Creates a command to update a Type selected by its ID using one update action.

Parameters:

versioned - the object to update (so directly a Type) or just the version/ID information of it

updateAction - the update to perform

updateActions - additional updates to perform

Returns:

the update command for Type

ofKey

static TypeUpdateCommand ofKey(String key,
                               Long version,
                               List<? extends UpdateAction<Type>> updateActions)

Creates a command to update a Type selected by its key using several update actions.

Parameters:

key - the key of the Type to update, see Type.getKey()

version - the current version of the Type, see Resource.getVersion()

updateActions - the updates

Returns:

the update command for Type

ofKey

static TypeUpdateCommand ofKey(String key,
                               Long version,
                               UpdateAction<Type> updateAction)

Creates a command to update a Type selected by its key using one update action.

Parameters:

key - the key of the Type to update, see Type.getKey()

version - the current version of the Type, see Resource.getVersion()

updateAction - the update to perform

Returns:

the update command for Type