com.contentful.java.cma

Class ModuleContentTypes.Async

java.lang.Object

com.contentful.java.cma.ModuleContentTypes.Async

Enclosing class:

ModuleContentTypes

public class ModuleContentTypes.Async
extends Object

Async module.

Constructor Summary

Constructors

Constructor and Description
Async()

Method Summary

Modifier and Type	Method and Description
CMACallback<CMAContentType>	create(CMAContentType contentType, CMACallback<CMAContentType> callback) Create a new Content Type using the configured space and environment.
CMACallback<CMAContentType>	create(String spaceId, String environmentId, CMAContentType contentType, CMACallback<CMAContentType> callback) Create a new Content Type in the given environment.
CMACallback<Integer>	delete(CMAContentType contentType, CMACallback<Integer> callback) Delete a Content Type.
CMACallback<CMAArray<CMAContentType>>	fetchAll(CMACallback<CMAArray<CMAContentType>> callback) Fetch all Content Types from the configured space and environment.
CMACallback<CMAArray<CMAContentType>>	fetchAll(Map<String,String> query, CMACallback<CMAArray<CMAContentType>> callback) Fetch all Content Types from the configured space and environment with a query.
CMACallback<CMAArray<CMAContentType>>	fetchAll(String spaceId, String environmentId, CMACallback<CMAArray<CMAContentType>> callback) Fetch all Content Types from the given space and environment.
CMACallback<CMAArray<CMAContentType>>	fetchAll(String spaceId, String environmentId, Map<String,String> query, CMACallback<CMAArray<CMAContentType>> callback) Fetch all Content Types from the given space and environment using a query.
CMACallback<CMAArray<CMASnapshot>>	fetchAllSnapshots(CMAContentType contentType, CMACallback<CMAArray<CMASnapshot>> callback) Fetch all snapshots of this content type.
CMACallback<CMAContentType>	fetchOne(String contentTypeId, CMACallback<CMAContentType> callback) Fetch a Content Type with the given contentTypeId from the configured space and environment.
CMACallback<CMAContentType>	fetchOne(String spaceId, String environmentId, String contentTypeId, CMACallback<CMAContentType> callback) Fetch a Content Type with the given contentTypeId from the given space.
CMACallback<CMASnapshot>	fetchOneSnapshot(CMAContentType contentType, String snapshotId, CMACallback<CMASnapshot> callback) Fetch a specific snapshot of this content type.
CMACallback<CMAContentType>	publish(CMAContentType contentType, CMACallback<CMAContentType> callback) Publish a Content Type.
CMACallback<CMAContentType>	unPublish(CMAContentType contentType, CMACallback<CMAContentType> callback) Un-Publish a Content Type.
CMACallback<CMAContentType>	update(CMAContentType contentType, CMACallback<CMAContentType> callback) Update a Content Type.

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

create

public CMACallback<CMAContentType> create(CMAContentType contentType,
                                          CMACallback<CMAContentType> callback)

Create a new Content Type using the configured space and environment.

In case the given contentType has an ID associated with it, that ID will be used, otherwise the server will auto-generate an ID that will be contained in the response upon success.

Parameters:

contentType - Content Type

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if configured space id is null.

IllegalArgumentException - if configured environment id is null.

IllegalArgumentException - if contentType is null.

IllegalArgumentException - if contentTypeId is null.

See Also:

CMAClient.Builder.setSpaceId(String), CMAClient.Builder.setEnvironmentId(String)

create

public CMACallback<CMAContentType> create(String spaceId,
                                          String environmentId,
                                          CMAContentType contentType,
                                          CMACallback<CMAContentType> callback)

Create a new Content Type in the given environment.

In case the given contentType has an ID associated with it, that ID will be used, otherwise the server will auto-generate an ID that will be contained in the response upon success.

This method will override the configuration specified through CMAClient.Builder.setSpaceId(String) and CMAClient.Builder.setEnvironmentId(String).

Parameters:

spaceId - Space ID

environmentId - Environment ID

contentType - Content Type

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if environmentId is null.

IllegalArgumentException - if contentType is null.

IllegalArgumentException - if contentTypeId is null.

delete

public CMACallback<Integer> delete(CMAContentType contentType,
                                   CMACallback<Integer> callback)

Delete a Content Type.

Parameters:

contentType - Content Type

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if contentTypeId is null.

fetchAll

public CMACallback<CMAArray<CMAContentType>> fetchAll(CMACallback<CMAArray<CMAContentType>> callback)

Fetch all Content Types from the configured space and environment.

Parameters:

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if configured space id is null.

IllegalArgumentException - if configured environment id is null.

See Also:

CMAClient.Builder.setSpaceId(String), CMAClient.Builder.setEnvironmentId(String)

fetchAll

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

Fetch all Content Types from the configured space and environment with a query.

Parameters:

query - Query

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if the configured space id is null.

IllegalArgumentException - if the configured environment id is null.

See Also:

CMAClient.Builder.setSpaceId(String), CMAClient.Builder.setEnvironmentId(String)

fetchAll

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

Fetch all Content Types from the given space and environment.

This method will override the configuration specified through CMAClient.Builder.setSpaceId(String) and CMAClient.Builder.setEnvironmentId(String).

Parameters:

spaceId - Space ID

environmentId - Environment ID

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if environment id is null.

fetchAll

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

Fetch all Content Types from the given space and environment using a query.

This method will override the configuration specified through CMAClient.Builder.setSpaceId(String) and CMAClient.Builder.setEnvironmentId(String).

Parameters:

spaceId - Space ID

environmentId - Environment ID

callback - Callback

query - Query

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if environment id is null.

IllegalArgumentException - if query is null.

fetchOne

public CMACallback<CMAContentType> fetchOne(String contentTypeId,
                                            CMACallback<CMAContentType> callback)

Fetch a Content Type with the given contentTypeId from the configured space and environment.

Parameters:

contentTypeId - Content Type ID

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if configured space id is null.

IllegalArgumentException - if configured environment id is null.

IllegalArgumentException - if contentTypeId is null.

See Also:

CMAClient.Builder.setSpaceId(String), CMAClient.Builder.setEnvironmentId(String)

fetchOne

public CMACallback<CMAContentType> fetchOne(String spaceId,
                                            String environmentId,
                                            String contentTypeId,
                                            CMACallback<CMAContentType> callback)

Fetch a Content Type with the given contentTypeId from the given space.

This method will override the configuration specified through CMAClient.Builder.setSpaceId(String) and CMAClient.Builder.setEnvironmentId(String).

Parameters:

spaceId - Space ID

environmentId - Environment ID

contentTypeId - Content Type ID

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if space id is null.

IllegalArgumentException - if environment id is null.

IllegalArgumentException - if contentTypeId is null.

publish

public CMACallback<CMAContentType> publish(CMAContentType contentType,
                                           CMACallback<CMAContentType> callback)

Publish a Content Type.

Parameters:

contentType - Content Type

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if contentType is null.

IllegalArgumentException - if contentType's id is null.

IllegalArgumentException - if contentType's space id is null.

unPublish

public CMACallback<CMAContentType> unPublish(CMAContentType contentType,
                                             CMACallback<CMAContentType> callback)

Un-Publish a Content Type.

Parameters:

contentType - Content Type

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if contentType is null.

IllegalArgumentException - if contentType's id is null.

IllegalArgumentException - if contentType's space id is null.

update

public CMACallback<CMAContentType> update(CMAContentType contentType,
                                          CMACallback<CMAContentType> callback)

Update a Content Type.

Parameters:

contentType - Content Type

callback - Callback

Returns:

the given CMACallback instance

Throws:

IllegalArgumentException - if contentType is null.

IllegalArgumentException - if contentType's name is null.

IllegalArgumentException - if contentType's id is null.

IllegalArgumentException - if contentType's space id is null.

IllegalArgumentException - if contentType's version is null.

fetchAllSnapshots

public CMACallback<CMAArray<CMASnapshot>> fetchAllSnapshots(CMAContentType contentType,
                                                            CMACallback<CMAArray<CMASnapshot>> callback)

Fetch all snapshots of this content type.

Parameters:

contentType - the contentType whose snapshots to be returned.

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

Returns:

the callback.

Throws:

IllegalArgumentException - if contentType is null.

IllegalArgumentException - if contentType's id is null.

IllegalArgumentException - if contentType's space id is null.

fetchOneSnapshot

public CMACallback<CMASnapshot> fetchOneSnapshot(CMAContentType contentType,
                                                 String snapshotId,
                                                 CMACallback<CMASnapshot> callback)

Fetch a specific snapshot of this content type.

Parameters:

contentType - the contentType whose snapshot to be returned.

snapshotId - the snapshot to be returned.

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

Returns:

a callback to inform about transaction results.

Throws:

IllegalArgumentException - if contentType is null.

IllegalArgumentException - if contentType's id is null.

IllegalArgumentException - if contentType's space id is null.

IllegalArgumentException - if snapshotId is null.