com.contentful.java.cma.model

Class CMASpaceMembership

java.lang.Object

com.contentful.java.cma.model.CMAResource

com.contentful.java.cma.model.CMASpaceMembership

public class CMASpaceMembership
extends CMAResource

Model class, exposing a space membership.

Constructor Summary

Constructors

Constructor and Description
CMASpaceMembership() Create a new membership.

Method Summary

Modifier and Type	Method and Description
CMASpaceMembership	addRole(CMALink role) Add a role to the list of roles.
String	getEmail() Get email of membership.
List<CMALink>	getRoles()
CMALink	getUser()
boolean	isAdmin()
CMASpaceMembership	setAdmin(boolean admin) Update admin flag.
CMASpaceMembership	setEmail(String email) Set the email address when creating a new membership.
CMASpaceMembership	setId(String id) Sets the id of this space membership.
CMASpaceMembership	setIsAdmin(boolean admin) Update administrator state of this membership.
CMASpaceMembership	setRoles(CMALink... roles) Replace all roles with the given argument.
CMASpaceMembership	setSpaceId(String id) Sets the id of this space memberships space.
CMASpaceMembership	setUser(CMALink user) Update or set the user for this membership.
CMASpaceMembership	setVersion(Integer version) Set the version of this space membership.
String	toString()

Methods inherited from class com.contentful.java.cma.model.CMAResource

getId, getSpaceId, getSystem, getVersion, isArchived, isPublished, setSystem

Methods inherited from class java.lang.Object

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

Constructor Detail

CMASpaceMembership

public CMASpaceMembership()

Create a new membership.

Method Detail

getUser

public CMALink getUser()

Returns:

a link to the user of this membership

setUser

public CMASpaceMembership setUser(CMALink user)

Update or set the user for this membership.

Parameters:

user - which user should be part of this membership?

Returns:

this membership for ease of chaining.

getRoles

public List<CMALink> getRoles()

Returns:

a list of links to the roles this membership contains.

setRoles

public CMASpaceMembership setRoles(CMALink... roles)

Replace all roles with the given argument.

Parameters:

roles - the roles to be used.

Returns:

this instance of membership for ease of chaining.

Throws:

IllegalArgumentException - if roles is null.

IllegalArgumentException - if roles does not contain any elements.

addRole

public CMASpaceMembership addRole(CMALink role)

Add a role to the list of roles.

Parameters:

role - the role to be used, needs to be not null.

Returns:

this membership for ease of chaining.

Throws:

IllegalArgumentException - if role is null.

getEmail

public String getEmail()

Get email of membership.

This email will only be available, if this membership is created a new. You will never see this email address coming back from memberships.

Returns:

the set email address.

setEmail

public CMASpaceMembership setEmail(String email)

Set the email address when creating a new membership.

Parameters:

email - to be used for inviting people.

Returns:

this membership for ease of chaining.

Throws:

IllegalArgumentException - if email is null.

IllegalArgumentException - if email does not contain an '@'.

isAdmin

public boolean isAdmin()

Returns:

is this membership an administrator?

setAdmin

public CMASpaceMembership setAdmin(boolean admin)

Update admin flag.

If you set this flag to false, you have to provide some roles this membership should be part of.

Parameters:

admin - true, if this membership should be an admin.

Returns:

this membership for ease of chaining.

See Also:

setRoles(CMALink...), addRole(CMALink)

setIsAdmin

public CMASpaceMembership setIsAdmin(boolean admin)

Update administrator state of this membership.

Parameters:

admin - state of this membership.

Returns:

this instance fore ease of chaining.

setId

public CMASpaceMembership setId(String id)

Sets the id of this space membership.

Overrides:

setId in class CMAResource

Parameters:

id - to be set.

Returns:

this instance for chaining.

setVersion

public CMASpaceMembership setVersion(Integer version)

Set the version of this space membership.

Overrides:

setVersion in class CMAResource

Parameters:

version - the version to be set.

Returns:

this space instance for chaining.

setSpaceId

public CMASpaceMembership setSpaceId(String id)

Sets the id of this space memberships space.

Overrides:

setSpaceId in class CMAResource

Parameters:

id - the id to be set.

Returns:

this space instance for chaining.

See Also:

setId(String)

toString

public String toString()

Overrides:

toString in class CMAResource

Returns:

a human readable string, representing the object.