com.force.sdk.jpa.annotation
Annotation Type CustomField

@Target(value={METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface CustomField

CustomField annotation for setting metadata properties on fields in Force.com.

Author:

Fiaz Hossain

Optional Element Summary

String	childRelationshipName Force.com child relationship name.
String	description Force.com field description.
boolean	enableFeeds Enable Force.com Chatter feeds.
boolean	externalId Enable external Id on Force.com field.
String	formula Force.com field formula.
String	label Force.com field label.
int	length Force.com field length.
String	name Force.com field name.
int	precision Force.com field precision.
int	scale Force.com field scale.
int	startValue Start value for Force.com Autonumber field.
com.sforce.soap.metadata.TreatBlanksAs	treatBlanksAs Treat blank as value for Force.com Formulat field.
com.sforce.soap.metadata.FieldType	type Force.com field type.

type

public abstract com.sforce.soap.metadata.FieldType type

Force.com field type.

Default:

com.sforce.soap.metadata.FieldType.Text

name

public abstract String name

Force.com field name.

Default:

""

label

public abstract String label

Force.com field label.

Default:

""

description

public abstract String description

Force.com field description.

Default:

""

length

public abstract int length

Force.com field length.

Default:

0

precision

public abstract int precision

Force.com field precision.

Default:

0

scale

public abstract int scale

Force.com field scale.

Default:

0

startValue

public abstract int startValue

Start value for Force.com Autonumber field.

Default:

0

childRelationshipName

public abstract String childRelationshipName

Force.com child relationship name.

Default:

""

enableFeeds

public abstract boolean enableFeeds

Enable Force.com Chatter feeds.

Default:

false

externalId

public abstract boolean externalId

Enable external Id on Force.com field.

Default:

false

formula

public abstract String formula

Force.com field formula.

Default:

""

treatBlanksAs

public abstract com.sforce.soap.metadata.TreatBlanksAs treatBlanksAs

Treat blank as value for Force.com Formulat field.

Default:

com.sforce.soap.metadata.TreatBlanksAs.BlankAsBlank