org.apache.camel.component.salesforce.api.dto

Class AbstractDescribedSObjectBase

java.lang.Object

org.apache.camel.component.salesforce.api.dto.AbstractDTOBase

org.apache.camel.component.salesforce.api.dto.AbstractSObjectBase

org.apache.camel.component.salesforce.api.dto.AbstractDescribedSObjectBase

public abstract class AbstractDescribedSObjectBase
extends AbstractSObjectBase

Subclass of AbstractSObjectBase that contains additional metadata about SObject. The camel-salesforce-maven-plugin generates Data Transfer Objects (DTO) by subclassing this class and implementing the description() method from the metadata received from Salesforce. Note that there are no guarantees about all fields in the SObjectDescription being set. This is to prevent unnecessary memory usage, and to prevent running into Java method length limit.

Constructor Summary

Constructors

Constructor and Description
AbstractDescribedSObjectBase()

Method Summary

Modifier and Type	Method and Description
protected static SObjectField	createField(String name, String label, String type, String soapType, int length, boolean unique, boolean nillable, boolean nameField, boolean externalId, boolean custom, boolean caseSensitive, boolean idLookup)
abstract SObjectDescription	description() Additional metadata about this SObject.

Methods inherited from class org.apache.camel.component.salesforce.api.dto.AbstractSObjectBase

clearBaseFields, getAttributes, getCreatedById, getCreatedDate, getFieldsToNull, getId, getLastActivityDate, getLastModifiedById, getLastModifiedDate, getLastReferencedDate, getLastViewedDate, getName, getOwnerId, getSystemModstamp, isIsDeleted, setAttributes, setCreatedById, setCreatedDate, setFieldsToNull, setId, setIsDeleted, setLastActivityDate, setLastModifiedById, setLastModifiedDate, setLastReferencedDate, setLastViewedDate, setName, setOwnerId, setSystemModstamp

Methods inherited from class org.apache.camel.component.salesforce.api.dto.AbstractDTOBase

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDescribedSObjectBase

public AbstractDescribedSObjectBase()

Method Detail

description

public abstract SObjectDescription description()

Additional metadata about this SObject. There are no guarantees that all of the fields of SObjectDescription will be set.

Returns:

metadata description of this SObject

createField

protected static SObjectField createField(String name,
                                          String label,
                                          String type,
                                          String soapType,
                                          int length,
                                          boolean unique,
                                          boolean nillable,
                                          boolean nameField,
                                          boolean externalId,
                                          boolean custom,
                                          boolean caseSensitive,
                                          boolean idLookup)