com.contentful.java.cma

Class ModuleEntries

java.lang.Object

com.contentful.java.cma.ModuleEntries

public final class ModuleEntries
extends Object

Entries Module.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ModuleEntries.Async Async module.

Constructor Summary

Constructors

Constructor and Description
ModuleEntries(retrofit2.Retrofit retrofit, Executor callbackExecutor)

Method Summary

Modifier and Type	Method and Description
CMAEntry	archive(CMAEntry entry) Archive an Entry.
ModuleEntries.Async	async()
CMAEntry	create(String spaceId, String contentTypeId, CMAEntry entry) Create a new Entry.
protected com.contentful.java.cma.ServiceEntries	createService(retrofit2.Retrofit retrofit)
Integer	delete(String spaceId, String entryId) Delete an Entry.
CMAArray<CMAEntry>	fetchAll(String spaceId) Fetch all Entries from a Space.
CMAArray<CMAEntry>	fetchAll(String spaceId, Map<String,String> query) Fetch all Entries from a Space with a query url parameter map.
CMAArray<CMASnapshot>	fetchAllSnapshots(CMAEntry entry) Fetch all snapshots of an entry.
CMAEntry	fetchOne(String spaceId, String entryId) Fetch an Entry with the given entryId from a Space.
CMASnapshot	fetchOneSnapshot(CMAEntry entry, String snapshotId) Fetch a specific snapshot of an entry.
CMAEntry	publish(CMAEntry entry) Publish an Entry.
CMAEntry	unArchive(CMAEntry entry) Un-Archive an Entry.
CMAEntry	unPublish(CMAEntry entry) Un-Publish an Entry.
CMAEntry	update(CMAEntry entry) Update an Entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleEntries

public ModuleEntries(retrofit2.Retrofit retrofit,
                     Executor callbackExecutor)

Method Detail

createService

protected com.contentful.java.cma.ServiceEntries createService(retrofit2.Retrofit retrofit)

archive

public CMAEntry archive(CMAEntry entry)

Archive an Entry.

Parameters:

entry - Entry

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

create

public CMAEntry create(String spaceId,
                       String contentTypeId,
                       CMAEntry entry)

Create a new Entry.

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:

spaceId - Space ID

contentTypeId - Content Type ID

entry - Entry

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if entry is null.

delete

public Integer delete(String spaceId,
                      String entryId)

Delete an Entry.

Parameters:

spaceId - Space ID

entryId - Entry ID

Returns:

Integer representing the success (204) of the action

Throws:

IllegalArgumentException - if spaceId is null.

IllegalArgumentException - if entry is null.

fetchAll

public CMAArray<CMAEntry> fetchAll(String spaceId)

Fetch all Entries from a Space.

This fetch uses the default parameter defined in DefaultQueryParameter.FETCH

Parameters:

spaceId - Space ID

Returns:

CMAArray result instance

Throws:

IllegalArgumentException - if spaceId is null.

fetchAll

public CMAArray<CMAEntry> fetchAll(String spaceId,
                                   Map<String,String> query)

Fetch all Entries from a Space with a query url parameter map.

Parameters:

spaceId - Space ID

query - Query

Returns:

CMAArray result instance

Throws:

IllegalArgumentException - if spaceId is null.

fetchOne

public CMAEntry fetchOne(String spaceId,
                         String entryId)

Fetch an Entry with the given entryId from a Space.

Parameters:

spaceId - Space ID

entryId - Entry ID

Returns:

CMAEntry result instance

publish

public CMAEntry publish(CMAEntry entry)

Publish an Entry.

Parameters:

entry - Entry

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

unArchive

public CMAEntry unArchive(CMAEntry entry)

Un-Archive an Entry.

Parameters:

entry - Entry

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

unPublish

public CMAEntry unPublish(CMAEntry entry)

Un-Publish an Entry.

Parameters:

entry - Entry

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

update

public CMAEntry update(CMAEntry entry)

Update an Entry.

Parameters:

entry - Entry

Returns:

CMAEntry result instance

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

IllegalArgumentException - if entry's version is null.

fetchAllSnapshots

public CMAArray<CMASnapshot> fetchAllSnapshots(CMAEntry entry)

Fetch all snapshots of an entry.

Parameters:

entry - the entry whose snapshots to be returned.

Returns:

an array of snapshots.

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

fetchOneSnapshot

public CMASnapshot fetchOneSnapshot(CMAEntry entry,
                                    String snapshotId)

Fetch a specific snapshot of an entry.

Parameters:

entry - the entry whose snapshot to be returned.

snapshotId - the snapshot to be returned.

Returns:

an array of snapshots.

Throws:

IllegalArgumentException - if entry is null.

IllegalArgumentException - if entry's id is null.

IllegalArgumentException - if entry's space id is null.

IllegalArgumentException - if snapshotId is null.

async

public ModuleEntries.Async async()

Returns:

a module with a set of asynchronous methods.