com.contentful.java.cma

Class ModuleLocales.Async

java.lang.Object

com.contentful.java.cma.ModuleLocales.Async

Enclosing class:

ModuleLocales

public final class ModuleLocales.Async
extends Object

Handler for asynchronous requests.

Constructor Summary

Constructors

Constructor and Description
Async()

Method Summary

Modifier and Type	Method and Description
CMACallback<CMALocale>	create(String spaceId, CMALocale locale, CMACallback<CMALocale> callback) Asynchronously create a new locale.
CMACallback<Integer>	delete(String spaceId, CMALocale locale, CMACallback<Integer> callback) Delete the given locale instance asynchronously.
CMACallback<CMAArray<CMALocale>>	fetchAll(String spaceId, CMACallback<CMAArray<CMALocale>> callback) Fetch all locales of this space, asynchronously.
CMACallback<CMAArray<CMALocale>>	fetchAll(String spaceId, Map<String,String> query, CMACallback<CMAArray<CMALocale>> callback) Fetch specific locales of this space.
CMACallback<CMALocale>	fetchOne(String spaceId, String localeId, CMACallback<CMALocale> callback) Fetches one locale by its id from Contentful asynchronously.
CMACallback<CMALocale>	update(CMALocale locale, CMACallback<CMALocale> callback) Update the given locale instance on Contentful, asynchronously.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Async

public Async()

Method Detail

fetchAll

public CMACallback<CMAArray<CMALocale>> fetchAll(String spaceId,
                                                 CMACallback<CMAArray<CMALocale>> callback)

Fetch all locales of this space, asynchronously.

Parameters:

spaceId - the space identifier identifying the space.

callback - a callback to be called, once the results are present.

Returns:

a callback for the array fetched.

Throws:

IllegalArgumentException - if spaceId is null.

See Also:

ModuleLocales.fetchAll(String)

fetchAll

public CMACallback<CMAArray<CMALocale>> fetchAll(String spaceId,
                                                 Map<String,String> query,
                                                 CMACallback<CMAArray<CMALocale>> callback)

Fetch specific locales of this space.

Parameters:

spaceId - the space identifier identifying the space.

query - the search criteria to search for.

callback - the callback to be informed about success or failure.

Returns:

the callback passed in.

Throws:

IllegalArgumentException - if spaceId is null.

See Also:

ModuleLocales.fetchAll(String)

fetchOne

public CMACallback<CMALocale> fetchOne(String spaceId,
                                       String localeId,
                                       CMACallback<CMALocale> callback)

Fetches one locale by its id from Contentful asynchronously.

Parameters:

spaceId - the space this locale is hosted by.

localeId - the id of the locale to be found.

callback - a callback to be called, once the results are present.

Returns:

a callback handling the response.

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if locale id is null.

See Also:

ModuleLocales.fetchOne(String, String)

create

public CMACallback<CMALocale> create(String spaceId,
                                     CMALocale locale,
                                     CMACallback<CMALocale> callback)

Asynchronously create a new locale.

Parameters:

spaceId - the space id to host the locale.

locale - the new locale to be created.

callback - a callback to be called, once the results are present.

Returns:

a callback for the responses.

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if locale is null.

See Also:

ModuleLocales.create(String, CMALocale)

update

public CMACallback<CMALocale> update(CMALocale locale,
                                     CMACallback<CMALocale> callback)

Update the given locale instance on Contentful, asynchronously.

Please make sure that the instance provided is fetched from Contentful. Otherwise you will get an exception thrown.

Parameters:

locale - the locale fetched from Contentful, updated by caller, to be updated.

callback - a callback to be called, once the results are present.

Returns:

the updated locale callback.

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if locale is null.

IllegalArgumentException - if locale id is null.

IllegalArgumentException - if locale does not have a version attached.

See Also:

ModuleLocales.update(CMALocale)

delete

public CMACallback<Integer> delete(String spaceId,
                                   CMALocale locale,
                                   CMACallback<Integer> callback)

Delete the given locale instance asynchronously.

Please make sure that the instance provided is fetched from Contentful. Otherwise you will get an exception thrown.

Parameters:

spaceId - the id of the space to be used.

locale - the locale fetched from Contentful, updated by caller, to be deleted.

callback - a callback to be called, once the results are present.

Returns:

a callback for asynchronous interaction.

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if locale id is null.

See Also:

ModuleLocales.delete(String, CMALocale)