Package com.contentful.java.cma

Class ModuleSpaces

java.lang.Object

com.contentful.java.cma.ModuleSpaces

public class ModuleSpaces
extends java.lang.Object

Spaces Module.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ModuleSpaces(retrofit2.Retrofit retrofit, java.util.concurrent.Executor callbackExecutor, boolean environmentIdConfigured)	Create the spaces module.

Method Summary

Modifier and Type	Method	Description
ModuleSpaces.Async	async()
CMASpace	create(CMASpace space)	Create a Space.
CMASpace	create(CMASpace space, java.lang.String organizationId)	Create a Space in an organization.
CMASpace	create(java.lang.String spaceName)	Create a Space.
CMASpace	create(java.lang.String spaceName, java.lang.String organizationId)	Create a Space in an Organization.
protected com.contentful.java.cma.ServiceSpaces	createService(retrofit2.Retrofit retrofit)
java.lang.Integer	delete(CMASpace space)	Delete a Space.
java.lang.Integer	delete(java.lang.String spaceId)	Delete a Space.
CMAArray<CMASpace>	fetchAll()	Fetch all Spaces.
CMAArray<CMASpace>	fetchAll(java.util.Map<java.lang.String,java.lang.String> query)	Fetch all Spaces, using specific queries.
CMASpace	fetchOne(java.lang.String spaceId)	Fetch a Space with a given spaceId.
CMASpace	update(CMASpace space)	Update a Space.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleSpaces

public ModuleSpaces(retrofit2.Retrofit retrofit,
                    java.util.concurrent.Executor callbackExecutor,
                    boolean environmentIdConfigured)

Create the spaces module.

Parameters:

retrofit - the retrofit instance to be used to create the service.

callbackExecutor - to tell on which thread it should run.

environmentIdConfigured - internal helper to see if environment was set.

Method Detail

createService

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

create

public CMASpace create(java.lang.String spaceName)

Create a Space.

Parameters:

spaceName - Space name

Returns:

CMASpace result instance

Throws:

java.lang.IllegalArgumentException - if spaceName is null.

create

public CMASpace create(CMASpace space)

Create a Space.

Parameters:

space - CMASpace

Returns:

CMASpace result instance

Throws:

java.lang.IllegalArgumentException - if space is null.

create

public CMASpace create(java.lang.String spaceName,
                       java.lang.String organizationId)

Create a Space in an Organization.

Parameters:

spaceName - Space name

organizationId - organization ID

Returns:

CMASpace result instance

Throws:

java.lang.IllegalArgumentException - if spaceName is null.

java.lang.IllegalArgumentException - if organizationId is null.

create

public CMASpace create(CMASpace space,
                       java.lang.String organizationId)

Create a Space in an organization.

Parameters:

space - Space

organizationId - organization ID

Returns:

CMASpace result instance

Throws:

java.lang.IllegalArgumentException - if space is null.

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

java.lang.IllegalArgumentException - if organizationId is null.

delete

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

Delete a Space.

Parameters:

spaceId - Space ID

Returns:

Integer representing the result (204, or an error code)

Throws:

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

delete

public java.lang.Integer delete(CMASpace space)

Delete a Space.

Parameters:

space - Space

Returns:

Integer representing the result (204, or an error code)

Throws:

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

fetchAll

public CMAArray<CMASpace> fetchAll()

Fetch all Spaces.

Returns:

CMAArray result instance

fetchAll

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

Fetch all Spaces, using specific queries.

Parameters:

query - filter the results

Returns:

CMAArray result instance

fetchOne

public CMASpace fetchOne(java.lang.String spaceId)

Fetch a Space with a given spaceId.

Parameters:

spaceId - Space ID

Returns:

CMASpace result instance

Throws:

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

update

public CMASpace update(CMASpace space)

Update a Space.

Parameters:

space - Space

Returns:

CMASpace result instance

Throws:

java.lang.IllegalArgumentException - if space is null.

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

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

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

async

public ModuleSpaces.Async async()

Returns:

a module with a set of asynchronous methods.