Package com.force.api

Class DescribeSObject

java.lang.Object

com.force.api.DescribeSObjectBasic

com.force.api.DescribeSObject

public class DescribeSObject
extends DescribeSObjectBasic

This class represents a JSON response from /services/data/v{version}/sobjects/{sobjectName}/describe It has all of the fields for a particular sobject, and metadata about those fields.

Since:

172

Author:

gwester

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DescribeSObject.ChildEntity	Child Relationships.
static class	DescribeSObject.Field	This class represents part of a JSON response from /services/data/v{version}/sobjects/{sobjectName}/describe
static class	DescribeSObject.PicklistEntry	This class represents a picklist value as given by a describe api call.

Constructor Summary

Constructors

Constructor	Description
DescribeSObject()

Method Summary

Modifier and Type	Method	Description
List<DescribeSObject.Field>	getAllFields()
Map<String,String>	getChildEntities()
List<DescribeSObject.ChildEntity>	getChildRelationships()
List<DescribeSObject.Field>	getFields()
Set<DescribeSObject.Field>	getOptionalFieldsForCreateUpdate()
Set<DescribeSObject.Field>	getParentEntitiesForCreateUpdate()
Set<DescribeSObject.Field>	getRequiredFieldsForCreateUpdate()

Methods inherited from class com.force.api.DescribeSObjectBasic

getKeyPrefix, getLabel, getLabelPlural, getName, getUrls, isActivateable, isCreateable, isCustom, isCustomSetting, isDeletable, isDeprecatedAndHidden, isFeedEnabled, isLayoutable, isMergeable, isQueryable, isReplicateable, isRetrieveable, isSearchable, isTriggerable, isUndeletable, isUpdateable

Methods inherited from class java.lang.Object

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

Constructor Details

DescribeSObject

public DescribeSObject()

Method Details

getAllFields

public List<DescribeSObject.Field> getAllFields()

getFields

public List<DescribeSObject.Field> getFields()

getChildRelationships

public List<DescribeSObject.ChildEntity> getChildRelationships()

getChildEntities

public Map<String,String> getChildEntities()

Returns:

A map keyed child entities (e.g. Opportunity), with value of relationship name (e.g. childOpportunities).

getRequiredFieldsForCreateUpdate

public Set<DescribeSObject.Field> getRequiredFieldsForCreateUpdate()

getOptionalFieldsForCreateUpdate

public Set<DescribeSObject.Field> getOptionalFieldsForCreateUpdate()

getParentEntitiesForCreateUpdate

public Set<DescribeSObject.Field> getParentEntitiesForCreateUpdate()