com.force.sdk.jpa.table
Class TableName

java.lang.Object
  com.force.sdk.jpa.table.TableName

public final class TableName
extends Object

Force.com objects have names that consist of a namespace, the base name of the object, and a suffix (like __c). This class manages all of these elements.

Author:

Fiaz Hossain

Nested Class Summary

static class

TableName.Type Enum of all possible table types.

Method Summary

static TableName	createTableName(String namespace, org.datanucleus.metadata.AbstractClassMetaData acmd) Creates a TableName object with all the components necessary for Force.com API access, including the name of the object, the namespace, and the suffix if needed.
String	getForceApiName() Returns fully qualified Force.com API name for this TableName.
String	getName()
String	getNamespace()
TableName.Type	getType()
boolean	isCustom() Returns whether an object is user created or standard in Force.com.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

createTableName

public static TableName createTableName(String namespace,
                                        org.datanucleus.metadata.AbstractClassMetaData acmd)

Creates a TableName object with all the components necessary for Force.com API access, including the name of the object, the namespace, and the suffix if needed.

Parameters:

namespace - in most cases this will be the namespace of the organization holding the API connection

acmd - the metadata of the entity

Returns:

The name to use for Force.com API access

getName

public String getName()

getNamespace

public String getNamespace()

getForceApiName

public String getForceApiName()

Returns fully qualified Force.com API name for this TableName.

Returns:

fully qualified Force.com API name

isCustom

public boolean isCustom()

Returns whether an object is user created or standard in Force.com.

Returns:

true if this object is custom

getType

public TableName.Type getType()

toString

public String toString()

Overrides:

toString in class Object