com.sforce.rest
Class DescribeLayout

java.lang.Object
  com.sforce.rest.DescribeLayout

public class DescribeLayout
extends Object

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

static class	DescribeLayout.ChildEntity Child Relationships.
static class	DescribeLayout.Field This class represents part of a JSON response from /services/data/v{version}/sobjects/{sobjectName}/describe

Constructor Summary

DescribeLayout()

Method Summary

Set<DescribeLayout.Field>	getAllFields() All fields for the sobject.
Map<String,String>	getChildEntities()
String	getKeyPrefix()
String	getLabel()
String	getLabelPlural()
String	getName()
Set<DescribeLayout.Field>	getOptionalFieldsForCreateUpdate() Optional fields.
Set<DescribeLayout.Field>	getParentEntitiesForCreateUpdate() Parent entity references.
Set<DescribeLayout.Field>	getRequiredFieldsForCreateUpdate() Required fields.
Map<String,String>	getUrls()
Boolean	isActivateable()
Boolean	isCreateable()
Boolean	isCustom()
Boolean	isCustomSetting()
Boolean	isDeletable()
Boolean	isDeprecatedAndHidden()
Boolean	isFeedEnabled()
Boolean	isLayoutable()
Boolean	isMergeable()
Boolean	isQueryable()
Boolean	isReplicateable()
Boolean	isRetrieveable()
Boolean	isSearchable()
Boolean	isTriggerable()
Boolean	isUndeletable()
Boolean	isUpdateable()

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeLayout

public DescribeLayout()

Method Detail

getAllFields

public Set<DescribeLayout.Field> getAllFields()

All fields for the sobject.

Returns:

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<DescribeLayout.Field> getRequiredFieldsForCreateUpdate()

Required fields.

Returns:

getOptionalFieldsForCreateUpdate

public Set<DescribeLayout.Field> getOptionalFieldsForCreateUpdate()

Optional fields.

Returns:

getParentEntitiesForCreateUpdate

public Set<DescribeLayout.Field> getParentEntitiesForCreateUpdate()

Parent entity references.

Returns:

getName

public String getName()

Returns:

Name of the sobject.

getLabel

public String getLabel()

isCustom

public Boolean isCustom()

getKeyPrefix

public String getKeyPrefix()

getLabelPlural

public String getLabelPlural()

isLayoutable

public Boolean isLayoutable()

isActivateable

public Boolean isActivateable()

isUpdateable

public Boolean isUpdateable()

getUrls

public Map<String,String> getUrls()

isCreateable

public Boolean isCreateable()

isDeletable

public Boolean isDeletable()

isFeedEnabled

public Boolean isFeedEnabled()

isQueryable

public Boolean isQueryable()

isReplicateable

public Boolean isReplicateable()

isRetrieveable

public Boolean isRetrieveable()

isUndeletable

public Boolean isUndeletable()

isTriggerable

public Boolean isTriggerable()

isMergeable

public Boolean isMergeable()

isDeprecatedAndHidden

public Boolean isDeprecatedAndHidden()

isCustomSetting

public Boolean isCustomSetting()

isSearchable

public Boolean isSearchable()