Package com.contentful.java.cma

Class ModuleEntries.Async

java.lang.Object

com.contentful.java.cma.ModuleEntries.Async

Enclosing class:

ModuleEntries

public class ModuleEntries.Async
extends java.lang.Object

Async module.

Constructor Summary

Constructors

Constructor	Description
Async()

Method Summary

Modifier and Type	Method	Description
CMACallback<CMAEntry>	archive(CMAEntry entry, CMACallback<CMAEntry> callback)	Archive an Entry.
CMACallback<CMAEntry>	create(java.lang.String contentTypeId, CMAEntry entry, CMACallback<CMAEntry> callback)	Create a new Entry on the configured space and environment.
CMACallback<CMAEntry>	create(java.lang.String spaceId, java.lang.String environmentId, java.lang.String contentTypeId, CMAEntry entry, CMACallback<CMAEntry> callback)	Create a new entry in the given space and environment.
CMACallback<java.lang.Integer>	delete(CMAEntry entry, CMACallback<java.lang.Integer> callback)	Delete an Entry.
CMACallback<CMAArray<CMAEntry>>	fetchAll(CMACallback<CMAArray<CMAEntry>> callback)	Fetch all Entries from the configured space and environment.
CMACallback<CMAArray<CMAEntry>>	fetchAll(java.lang.String spaceId, java.lang.String environmentId, CMACallback<CMAArray<CMAEntry>> callback)	Fetch all entries from the given space and environment.
CMACallback<CMAArray<CMAEntry>>	fetchAll(java.lang.String spaceId, java.lang.String environmentId, java.util.Map<java.lang.String,java.lang.String> query, CMACallback<CMAArray<CMAEntry>> callback)	Fetch all Entries from a Space with a query.
CMACallback<CMAArray<CMAEntry>>	fetchAll(java.util.Map<java.lang.String,java.lang.String> query, CMACallback<CMAArray<CMAEntry>> callback)	Fetch all entries in the space and environment matching the given query.
CMACallback<CMAArray<CMASnapshot>>	fetchAllSnapshots(CMAEntry entry, CMACallback<CMAArray<CMASnapshot>> callback)	Fetch all snapshots of an entry.
CMACallback<CMAEntry>	fetchOne(java.lang.String entryId, CMACallback<CMAEntry> callback)	Fetch an Entry with the given entryId from the configured space and environment.
CMACallback<CMAEntry>	fetchOne(java.lang.String spaceId, java.lang.String environmentId, java.lang.String entryId, CMACallback<CMAEntry> callback)	Fetch an Entry with the given entryId from a Space.entry
CMACallback<CMASnapshot>	fetchOneSnapshot(CMAEntry entry, java.lang.String snapshotId, CMACallback<CMASnapshot> callback)	Fetch a specific snapshot of an entry.
CMACallback<CMAEntry>	publish(CMAEntry entry, CMACallback<CMAEntry> callback)	Publish an Entry.
CMACallback<CMAEntry>	unArchive(CMAEntry entry, CMACallback<CMAEntry> callback)	Un-Archive an Entry.
CMACallback<CMAEntry>	unPublish(CMAEntry entry, CMACallback<CMAEntry> callback)	Un-Publish an Entry.
CMACallback<CMAEntry>	update(CMAEntry entry, CMACallback<CMAEntry> callback)	Update an Entry.

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

archive

public CMACallback<CMAEntry> archive(CMAEntry entry,
                                     CMACallback<CMAEntry> callback)

Archive an Entry.

Parameters:

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

java.lang.IllegalArgumentException - if entry is null.

java.lang.IllegalArgumentException - if entry's id is null.

create

public CMACallback<CMAEntry> create(java.lang.String contentTypeId,
                                    CMAEntry entry,
                                    CMACallback<CMAEntry> callback)

Create a new Entry on the configured space and environment.

In case the given entry 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:

contentTypeId - Content Type ID

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

java.lang.IllegalArgumentException - if configured spaceId is null.

java.lang.IllegalArgumentException - if configured entry is null.

java.lang.IllegalArgumentException - if contentTypeId is null.

java.lang.IllegalArgumentException - if entry is null.

See Also:

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

create

public CMACallback<CMAEntry> create(java.lang.String spaceId,
                                    java.lang.String environmentId,
                                    java.lang.String contentTypeId,
                                    CMAEntry entry,
                                    CMACallback<CMAEntry> callback)

Create a new entry in the given space and environment.

In case the given entry 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

contentTypeId - Content Type ID

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if environmentId is null.

java.lang.IllegalArgumentException - if contentTypeId is null.

java.lang.IllegalArgumentException - if entry is null.

delete

public CMACallback<java.lang.Integer> delete(CMAEntry entry,
                                             CMACallback<java.lang.Integer> callback)

Delete an Entry.

Parameters:

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if entry is null.

fetchAll

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

Fetch all Entries from the configured space and environment.

Parameters:

callback - Callback

Returns:

the given CMACallback instance

Throws:

java.lang.IllegalArgumentException - if configured spaceId is null.

java.lang.IllegalArgumentException - if configured environmentId is null.

See Also:

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

fetchAll

public CMACallback<CMAArray<CMAEntry>> fetchAll(java.util.Map<java.lang.String,java.lang.String> query,
                                                CMACallback<CMAArray<CMAEntry>> callback)

Fetch all entries in the space and environment matching the given query.

Parameters:

query - query to be performed

callback - Callback

Returns:

the given CMACallback instance

Throws:

java.lang.IllegalArgumentException - if configured spaceId is null.

java.lang.IllegalArgumentException - if configured environmentId is null.

See Also:

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

fetchAll

public CMACallback<CMAArray<CMAEntry>> fetchAll(java.lang.String spaceId,
                                                java.lang.String environmentId,
                                                CMACallback<CMAArray<CMAEntry>> callback)

Fetch all entries 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:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if environmentId is null.

fetchAll

public CMACallback<CMAArray<CMAEntry>> fetchAll(java.lang.String spaceId,
                                                java.lang.String environmentId,
                                                java.util.Map<java.lang.String,java.lang.String> query,
                                                CMACallback<CMAArray<CMAEntry>> callback)

Fetch all Entries from a Space with a query.

Parameters:

spaceId - Space ID

environmentId - Environment ID

query - Query

callback - Callback

Returns:

the given CMACallback instance

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if environmentId is null.

fetchOne

public CMACallback<CMAEntry> fetchOne(java.lang.String entryId,
                                      CMACallback<CMAEntry> callback)

Fetch an Entry with the given entryId from the configured space and environment.

Parameters:

entryId - Entry ID

callback - Callback

Returns:

the given CMACallback instance

Throws:

java.lang.IllegalArgumentException - if configured spaceId is null.

java.lang.IllegalArgumentException - if configured environmentId is null.

fetchOne

public CMACallback<CMAEntry> fetchOne(java.lang.String spaceId,
                                      java.lang.String environmentId,
                                      java.lang.String entryId,
                                      CMACallback<CMAEntry> callback)

Fetch an Entry with the given entryId from a Space.entry

Parameters:

spaceId - Space ID

environmentId - Environment ID

entryId - Entry ID

callback - Callback

Returns:

the given CMACallback instance

publish

public CMACallback<CMAEntry> publish(CMAEntry entry,
                                     CMACallback<CMAEntry> callback)

Publish an Entry.

Parameters:

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

java.lang.IllegalArgumentException - if entry is null.

java.lang.IllegalArgumentException - if entry's id is null.

java.lang.IllegalArgumentException - if entry's space id is null.

unArchive

public CMACallback<CMAEntry> unArchive(CMAEntry entry,
                                       CMACallback<CMAEntry> callback)

Un-Archive an Entry.

Parameters:

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

java.lang.IllegalArgumentException - if entry is null.

java.lang.IllegalArgumentException - if entry's id is null.

java.lang.IllegalArgumentException - if entry's space id is null.

unPublish

public CMACallback<CMAEntry> unPublish(CMAEntry entry,
                                       CMACallback<CMAEntry> callback)

Un-Publish an Entry.

Parameters:

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

Throws:

java.lang.IllegalArgumentException - if entry is null.

java.lang.IllegalArgumentException - if entry's id is null.

java.lang.IllegalArgumentException - if entry's space id is null.

update

public CMACallback<CMAEntry> update(CMAEntry entry,
                                    CMACallback<CMAEntry> callback)

Update an Entry.

Parameters:

entry - Entry

callback - Callback

Returns:

the given CMACallback instance

fetchAllSnapshots

public CMACallback<CMAArray<CMASnapshot>> fetchAllSnapshots(CMAEntry entry,
                                                            CMACallback<CMAArray<CMASnapshot>> callback)

Fetch all snapshots of an entry.

Parameters:

entry - the entry whose snapshots to be returned.

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

Returns:

a callback for an array of snapshots.

Throws:

java.lang.IllegalArgumentException - if entry is null.

java.lang.IllegalArgumentException - if entry's id is null.

java.lang.IllegalArgumentException - if entry's space id is null.

fetchOneSnapshot

public CMACallback<CMASnapshot> fetchOneSnapshot(CMAEntry entry,
                                                 java.lang.String snapshotId,
                                                 CMACallback<CMASnapshot> callback)

Fetch a specific snapshot of an entry.

Parameters:

entry - the entry whose snapshot to be returned.

snapshotId - the snapshot to be returned.

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

Returns:

a callback for an array of snapshots.

Throws:

java.lang.IllegalArgumentException - if entry is null.

java.lang.IllegalArgumentException - if entry's id is null.

java.lang.IllegalArgumentException - if entry's space id is null.

java.lang.IllegalArgumentException - if snapshotId is null.