io.sphere.sdk.projects.commands

Interface ProjectUpdateCommand

All Superinterfaces:

Command<Project>, SphereRequest<Project>

public interface ProjectUpdateCommand
extends Command<Project>

Update commands for the Project entity

final Project project = client().executeBlocking(ProjectGet.of());
final String new_project_name = "NewName";
final List<String> new_project_currencies = Arrays.asList(USD.getCurrencyCode());
final List<CountryCode> new_project_countries = Arrays.asList(CountryCode.CA);
final List<Locale> new_project_locales = Arrays.asList(Locale.FRANCE);
final List<String> new_project_languages = new_project_locales.stream().map(Locale::toLanguageTag).collect(Collectors.toList());
final Boolean new_project_messages_enabled = false;
final Long delete_days_after_activation = 20L;
final URL url = new URL("https://invalid.cmo");
final ExternalOAuth externalOAuth = ExternalOAuth.of("customheader: customValue", url);



final ProjectUpdateCommand updateCommand = ProjectUpdateCommand.of(project, Arrays.asList(
        ChangeName.of(new_project_name),
        ChangeCurrencies.of(new_project_currencies),
        ChangeCountries.of(new_project_countries),
        ChangeLanguages.of(new_project_languages),
        ChangeMessagesConfiguration.of(MessagesConfigurationDraft.of(new_project_messages_enabled, delete_days_after_activation)),
        SetShippingRateInputType.ofUnset(),
        SetExternalOAuth.of(externalOAuth)
));

final Project updatedProject = client().executeBlocking(updateCommand);

softAssert(soft -> {
    soft.assertThat(updatedProject.getKey()).isEqualTo(getSphereClientConfig().getProjectKey());
    soft.assertThat(updatedProject.getName()).as("name").isEqualTo(new_project_name);
    soft.assertThat(updatedProject.getCountries()).as("countries").isEqualTo(new_project_countries);
    soft.assertThat(updatedProject.getLanguages()).as("languages").isEqualTo(new_project_languages);
    soft.assertThat(updatedProject.getLanguageLocales()).as("languages as locale").isEqualTo(new_project_locales);
    soft.assertThat(updatedProject.getCreatedAt()).as("createdAt").isNotNull();
    soft.assertThat(updatedProject.getCurrencies()).as("currencies").isEqualTo(new_project_currencies);
    soft.assertThat(updatedProject.getCurrencyUnits()).as("currencies as unit").contains(USD);
    soft.assertThat(updatedProject.getMessages().isEnabled()).isEqualTo(new_project_messages_enabled);
    soft.assertThat(updatedProject.getMessages().getDeleteDaysAfterCreation()).isEqualTo(delete_days_after_activation);
    soft.assertThat(updatedProject.getShippingRateInputType()).isNull();
    soft.assertThat(updatedProject.getExternalOAuth()).isEqualToIgnoringGivenFields(externalOAuth,"authorizationHeader");
});
See the test code.

Method Summary

Modifier and Type	Method and Description
List<? extends UpdateAction<Project>>	getActions() The list of update actions to be performed on the project.
Long	getVersion() The expected version of the project on which the changes should be applied.
static ProjectUpdateCommand	of(Project project, List<? extends UpdateAction<Project>> actions)
static ProjectUpdateCommand	of(Project project, UpdateAction<Project> action)

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

canDeserialize, deserialize, httpRequestIntent

Method Detail

getVersion

Long getVersion()

The expected version of the project on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.

Returns:

Project version

getActions

List<? extends UpdateAction<Project>> getActions()

The list of update actions to be performed on the project.

Returns:

update actions list

of

static ProjectUpdateCommand of(Project project,
                               List<? extends UpdateAction<Project>> actions)

of

static ProjectUpdateCommand of(Project project,
                               UpdateAction<Project> action)