com.sforce.rest
Class DescribeLayout

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

public class DescribeLayout
extends java.lang.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

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

All fields for the sobject.

Returns:

getChildEntities

public java.util.Map<java.lang.String,java.lang.String> getChildEntities()

Returns:

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

getRequiredFieldsForCreateUpdate

public java.util.Set<DescribeLayout.Field> getRequiredFieldsForCreateUpdate()

Required fields.

Returns:

getOptionalFieldsForCreateUpdate

public java.util.Set<DescribeLayout.Field> getOptionalFieldsForCreateUpdate()

Optional fields.

Returns:

getParentEntitiesForCreateUpdate

public java.util.Set<DescribeLayout.Field> getParentEntitiesForCreateUpdate()

Parent entity references.

Returns:

getName

public java.lang.String getName()

Returns:

Name of the sobject.

getLabel

public java.lang.String getLabel()

isCustom

public java.lang.Boolean isCustom()

getKeyPrefix

public java.lang.String getKeyPrefix()

getLabelPlural

public java.lang.String getLabelPlural()

isLayoutable

public java.lang.Boolean isLayoutable()

isActivateable

public java.lang.Boolean isActivateable()

isUpdateable

public java.lang.Boolean isUpdateable()

getUrls

public java.util.Map<java.lang.String,java.lang.String> getUrls()

isCreateable

public java.lang.Boolean isCreateable()

isDeletable

public java.lang.Boolean isDeletable()

isFeedEnabled

public java.lang.Boolean isFeedEnabled()

isQueryable

public java.lang.Boolean isQueryable()

isReplicateable

public java.lang.Boolean isReplicateable()

isRetrieveable

public java.lang.Boolean isRetrieveable()

isUndeletable

public java.lang.Boolean isUndeletable()

isTriggerable

public java.lang.Boolean isTriggerable()

isMergeable

public java.lang.Boolean isMergeable()

isDeprecatedAndHidden

public java.lang.Boolean isDeprecatedAndHidden()

isCustomSetting

public java.lang.Boolean isCustomSetting()

isSearchable

public java.lang.Boolean isSearchable()