com.contentful.java.cma.model

Class CMAResource

java.lang.Object

com.contentful.java.cma.model.CMAResource

Direct Known Subclasses:

CMAApiKey, CMAArray, CMAAsset, CMABulkAction, CMAConcept, CMAConceptScheme, CMAContentType, CMAEditorInterface, CMAEntry, CMAEnvironment, CMAError, CMALink, CMALocale, CMAOrganization, CMAPersonalAccessToken, CMAPreviewApiKey, CMARole, CMAScheduledAction, CMASnapshot, CMASpace, CMASpaceMembership, CMATag, CMAUiExtension, CMAUpload, CMAUsage, CMAUser, CMAWebhook, CMAWebhookCall, CMAWebhookCallDetail, CMAWebhookHealth

public class CMAResource
extends Object

Base CMA resource. All `things` you will be retrieving and sending from and to Contentful will be based on this class.

Constructor Summary

Constructors

Constructor and Description
CMAResource(CMAType type)

Method Summary

Modifier and Type	Method and Description
String	getEnvironmentId()
String	getId()
String	getSpaceId()
CMASystem	getSystem()
Integer	getVersion()
CMAVisibility	getVisibility()
Boolean	isArchived()
Boolean	isPublished()
<T extends CMAResource> T	setEnvironmentId(String environmentId) Convenience method for setting an environment id.
<T extends CMAResource> T	setId(String id) Sets the ID for this CMAResource.
<T extends CMAResource> T	setSpaceId(String spaceId) Convenience method for setting a space id.
<T extends CMAResource> T	setSystem(CMASystem system) Sets the system field.
<T extends CMAResource> T	setVersion(Integer version) Convenience method for setting a version.
<T extends CMAResource> T	setVisibility(CMAVisibility visibility) Convenience method for setting a version.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CMAResource

public CMAResource(CMAType type)

Method Detail

getSystem

public CMASystem getSystem()

Returns:

the system field.

setSystem

public <T extends CMAResource> T setSystem(CMASystem system)

Sets the system field.

Type Parameters:

T - resource type to be returned.

Parameters:

system - sets the system property.

Returns:

this, as casted to a resource, for the ease of chaining.

getId

public String getId()

Returns:

the sys.id value, null if it is does not exist.

setId

public <T extends CMAResource> T setId(String id)

Sets the ID for this CMAResource.

Type Parameters:

T - resource type to be returned.

Parameters:

id - to be set.

Returns:

this CMAResource instance.

getVersion

public Integer getVersion()

Returns:

the sys.version value, null if it does not exist.

getVisibility

public CMAVisibility getVisibility()

Returns:

the sys.visibility value, null if it does not exist.

setVersion

public <T extends CMAResource> T setVersion(Integer version)

Convenience method for setting a version.

Type Parameters:

T - the type of the CMAResource calling.

Parameters:

version - the version number to be set.

Returns:

the calling CMAResource for chaining.

setVisibility

public <T extends CMAResource> T setVisibility(CMAVisibility visibility)

Convenience method for setting a version.

Parameters:

visibility - the visibility to be set.

Returns:

the calling CMAResource for chaining.

getSpaceId

public String getSpaceId()

Returns:

the ID of the Space associated with this resource, null if it does not exist.

setSpaceId

public <T extends CMAResource> T setSpaceId(String spaceId)

Convenience method for setting a space id.

Type Parameters:

T - An implementation of CMAResource, normally used for chaining setter methods.

Parameters:

spaceId - the id to be set.

Returns:

the calling CMAResource for chaining.

getEnvironmentId

public String getEnvironmentId()

Returns:

the ID of the Environment associated with this resource, Constants.DEFAULT_ENVIRONMENT if it does not exist.

setEnvironmentId

public <T extends CMAResource> T setEnvironmentId(String environmentId)

Convenience method for setting an environment id.

Type Parameters:

T - An implementation of CMAResource, normally used for chaining setter methods.

Parameters:

environmentId - the id to be set.

Returns:

the calling CMAResource for chaining.

isArchived

public Boolean isArchived()

Returns:

true if this resource is archived.

isPublished

public Boolean isPublished()

Returns:

true if this resource is published.

toString

public String toString()

Overrides:

toString in class Object

Returns:

a human readable string, representing the object.