com.contentful.java.cma

Class ModuleContentTypes

java.lang.Object

com.contentful.java.cma.ModuleContentTypes

public final class ModuleContentTypes
extends java.lang.Object

Content Types Module.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ModuleContentTypes(retrofit2.Retrofit retrofit, java.util.concurrent.Executor callbackExecutor)

Method Summary

Modifier and Type	Method and Description
ModuleContentTypes.Async	async()
CMAContentType	create(java.lang.String spaceId, CMAContentType contentType) Create a new Content Type.
protected com.contentful.java.cma.ServiceContentTypes	createService(retrofit2.Retrofit retrofit)
java.lang.Integer	delete(java.lang.String spaceId, java.lang.String contentTypeId) Delete a Content Type.
CMAArray<CMAContentType>	fetchAll(java.lang.String spaceId) Fetch all Content Types from a Space, using default query parameter.
CMAArray<CMAContentType>	fetchAll(java.lang.String spaceId, java.util.Map<java.lang.String,java.lang.String> query) Fetch all Content Types from a Space with query parameters.
CMAArray<CMASnapshot>	fetchAllSnapshots(CMAContentType contentType) Fetch all snapshots of this content type.
CMAContentType	fetchOne(java.lang.String spaceId, java.lang.String contentTypeId) Fetch a Content Type with the given contentTypeId from a Space.
CMASnapshot	fetchOneSnapshot(CMAContentType contentType, java.lang.String snapshotId) Fetch a specific snapshot of this content type.
CMAContentType	publish(CMAContentType contentType) Publish a Content Type.
CMAContentType	unPublish(CMAContentType contentType) Un-Publish a Content Type.
CMAContentType	update(CMAContentType contentType) Update a Content Type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleContentTypes

public ModuleContentTypes(retrofit2.Retrofit retrofit,
                          java.util.concurrent.Executor callbackExecutor)

Method Detail

createService

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

create

public CMAContentType create(java.lang.String spaceId,
                             CMAContentType contentType)

Create a new Content Type. 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:

spaceId - Space ID

contentType - Content Type

Returns:

CMAContentType result instance

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if contentType is null.

delete

public java.lang.Integer delete(java.lang.String spaceId,
                                java.lang.String contentTypeId)

Delete a Content Type.

Parameters:

spaceId - Space ID

contentTypeId - Content Type ID

Returns:

Integer representing the result of the operation

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if contentTypeId is null.

fetchAll

public CMAArray<CMAContentType> fetchAll(java.lang.String spaceId)

Fetch all Content Types from a Space, using default query parameter.

This fetch uses the default parameter defined in DefaultQueryParameter.FETCH

Parameters:

spaceId - Space ID

Returns:

CMAArray result instance

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

fetchAll

public CMAArray<CMAContentType> fetchAll(java.lang.String spaceId,
                                         java.util.Map<java.lang.String,java.lang.String> query)

Fetch all Content Types from a Space with query parameters.

Parameters:

spaceId - Space ID

query - Query to narrow down the content_types to be searched for

Returns:

CMAArray result instance

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

fetchOne

public CMAContentType fetchOne(java.lang.String spaceId,
                               java.lang.String contentTypeId)

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

Parameters:

spaceId - Space ID

contentTypeId - Content Type ID

Returns:

CMAContentType result instance

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if contentTypeId is null.

publish

public CMAContentType publish(CMAContentType contentType)

Publish a Content Type.

Parameters:

contentType - Content Type

Returns:

CMAContentType result instance

Throws:

java.lang.IllegalArgumentException - if contentType is null.

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

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

unPublish

public CMAContentType unPublish(CMAContentType contentType)

Un-Publish a Content Type.

Parameters:

contentType - Content Type

Returns:

CMAContentType result instance

Throws:

java.lang.IllegalArgumentException - if contentType is null.

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

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

update

public CMAContentType update(CMAContentType contentType)

Update a Content Type.

Parameters:

contentType - Content Type

Returns:

CMAContentType result instance

Throws:

java.lang.IllegalArgumentException - if contentType is null.

java.lang.IllegalArgumentException - if contentType's name is null.

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

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

java.lang.IllegalArgumentException - if contentType's version is null.

fetchAllSnapshots

public CMAArray<CMASnapshot> fetchAllSnapshots(CMAContentType contentType)

Fetch all snapshots of this content type.

Parameters:

contentType - the contentType whose snapshots to be returned.

Returns:

an array of snapshots.

Throws:

java.lang.IllegalArgumentException - if contentType is null.

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

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

fetchOneSnapshot

public CMASnapshot fetchOneSnapshot(CMAContentType contentType,
                                    java.lang.String snapshotId)

Fetch a specific snapshot of this content type.

Parameters:

contentType - the contentType whose snapshot to be returned.

snapshotId - the snapshot to be returned.

Returns:

an array of snapshots.

Throws:

java.lang.IllegalArgumentException - if contentType is null.

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

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

java.lang.IllegalArgumentException - if snapshotId is null.

async

public ModuleContentTypes.Async async()

Returns:

a module with a set of asynchronous methods.