io.sphere.sdk.types.commands

Interface TypeCreateCommand

All Superinterfaces:

Command<Type>, CreateCommand<Type>, DraftBasedCreateCommand<Type,TypeDraft>, DraftBasedCreateCommandDsl<Type,TypeDraft,TypeCreateCommand>, ExpansionPathContainer<Type>, MetaModelReferenceExpansionDsl<Type,TypeCreateCommand,TypeExpansionModel<Type>>, ReferenceExpansionDsl<Type,TypeCreateCommand>, ReferenceExpansionSupport<Type>, SphereRequest<Type>

public interface TypeCreateCommand
extends DraftBasedCreateCommandDsl<Type,TypeDraft,TypeCreateCommand>, MetaModelReferenceExpansionDsl<Type,TypeCreateCommand,TypeExpansionModel<Type>>

Command object to create a Type.

final FieldDefinition stringFieldDefinition =
        FieldDefinition.of(StringFieldType.of(), "string-field-name", en("label"), false, TextInputHint.SINGLE_LINE);
final String typeKey = "type-key";
final TypeDraft typeDraft = TypeDraftBuilder.of(typeKey, en("name of the custom type"), singleton(Category.referenceTypeId()))
        .description(en("description"))
        .fieldDefinitions(singletonList(stringFieldDefinition))
        .build();
final Type type = client().executeBlocking(TypeCreateCommand.of(typeDraft));
assertThat(type.getKey()).isEqualTo(typeKey);
assertThat(type.getName()).isEqualTo(en("name of the custom type"));
assertThat(type.getResourceTypeIds()).containsExactly(Category.referenceTypeId());
assertThat(type.getDescription()).isEqualTo(en("description"));
assertThat(type.getFieldDefinitions()).containsExactly(stringFieldDefinition);
See the test code.

See Also:

TypeDraft, Type

Method Summary

Modifier and Type	Method and Description
static TypeCreateCommand	of(TypeDraft draft) Creates a command object to create a Type.

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

getDraft, withDraft

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 TypeCreateCommand of(TypeDraft draft)

Creates a command object to create a Type.

Parameters:

draft - template to create the new object

Returns:

a new create command