public class

DescribeLayout

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

Class Overview

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.

Summary

Nested Classes
class DescribeLayout.ChildEntity Child Relationships. 
class DescribeLayout.Field This class represents part of a JSON response from /services/data/v{version}/sobjects/{sobjectName}/describe 
Fields
private Boolean activateable
private List<DescribeLayout.ChildEntity> childRelationships
private Boolean createable
private Boolean custom
private Boolean customSetting
private Boolean deletable
private Boolean deprecatedAndHidden
private Boolean feedEnabled
private Set<DescribeLayout.Field> fields
private String keyPrefix
private String label
private String labelPlural
private Boolean layoutable
private Boolean mergeable
private String name
private Boolean queryable
private Boolean replicateable
private Boolean retrieveable
private Boolean searchable
private Boolean triggerable
private Boolean undeletable
private Boolean updateable
private Map<String, String> urls
Public Constructors
DescribeLayout()
Public Methods
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()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private Boolean activateable

private List<DescribeLayout.ChildEntity> childRelationships

private Boolean createable

private Boolean custom

private Boolean customSetting

private Boolean deletable

private Boolean deprecatedAndHidden

private Boolean feedEnabled

private Set<DescribeLayout.Field> fields

private String keyPrefix

private String label

private String labelPlural

private Boolean layoutable

private Boolean mergeable

private String name

private Boolean queryable

private Boolean replicateable

private Boolean retrieveable

private Boolean searchable

private Boolean triggerable

private Boolean undeletable

private Boolean updateable

private Map<String, String> urls

Public Constructors

public DescribeLayout ()

Public Methods

public Set<DescribeLayout.Field> getAllFields ()

All fields for the sobject.

public Map<String, String> getChildEntities ()

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

public String getKeyPrefix ()

public String getLabel ()

public String getLabelPlural ()

public String getName ()

Returns
  • Name of the sobject.

public Set<DescribeLayout.Field> getOptionalFieldsForCreateUpdate ()

Optional fields.

public Set<DescribeLayout.Field> getParentEntitiesForCreateUpdate ()

Parent entity references.

public Set<DescribeLayout.Field> getRequiredFieldsForCreateUpdate ()

Required fields.

public Map<String, String> getUrls ()

public Boolean isActivateable ()

public Boolean isCreateable ()

public Boolean isCustom ()

public Boolean isCustomSetting ()

public Boolean isDeletable ()

public Boolean isDeprecatedAndHidden ()

public Boolean isFeedEnabled ()

public Boolean isLayoutable ()

public Boolean isMergeable ()

public Boolean isQueryable ()

public Boolean isReplicateable ()

public Boolean isRetrieveable ()

public Boolean isSearchable ()

public Boolean isTriggerable ()

public Boolean isUndeletable ()

public Boolean isUpdateable ()