Package com.simplicite.util.tools
Class SalesForceAPITool
- java.lang.Object
-
- com.simplicite.util.tools.SalesForceAPITool
-
public class SalesForceAPITool extends java.lang.Object
SalesForce API toolbox
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DATA_PATH
Data pathstatic java.lang.String
LOGIN_URL
Login URLstatic java.lang.String
METADATA_PATH
Metadata pathstatic java.lang.String
SOQL_PATH
Query path
-
Constructor Summary
Constructors Constructor Description SalesForceAPITool(Grant g, java.lang.String config)
ConstructorSalesForceAPITool(Grant g, org.json.JSONObject config)
Constructor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description org.json.JSONObject
getConfig()
Get configurationstatic java.lang.String
getFieldDefault(org.json.JSONObject fmd)
Get default value from field metadata and typestatic java.lang.String
getFieldHelp(org.json.JSONObject fmd)
Get help from field metadata and typestatic java.lang.String
getFieldLabel(org.json.JSONObject fmd)
Get label from field metadata and typestatic ListOfValuesData
getFieldListOfValues(org.json.JSONObject fmd)
Get list of values from field metadata and typestatic java.lang.String
getFieldName(org.json.JSONObject fmd)
Get name from field metadatastatic java.lang.String
getFieldReferencedObjectName(org.json.JSONObject fmd)
Get reference to object name from field metadatastatic java.lang.String
getFieldRendering(org.json.JSONObject fmd, int type)
Get rendering from field metadata and typestatic int
getFieldSearch(org.json.JSONObject fmd, int type)
Get search mode from field metadata and typestatic int
getFieldSearchReq(org.json.JSONObject fmd, int type, int search)
Get search required from field metadata and typestatic int
getFieldSize(org.json.JSONObject fmd, int type)
Get size from field metadata and typestatic int
getFieldType(org.json.JSONObject fmd)
Get type from field metadatastatic java.lang.String
getObjectName(org.json.JSONObject md)
Get object name from metadatastatic boolean
isRequired(org.json.JSONObject fmd, int type)
Is required from field metadata and typeorg.json.JSONObject
metadata(java.lang.String name)
Get object metadataorg.json.JSONObject
search(java.lang.String query)
Run a search queryorg.json.JSONObject
select(java.lang.String name, java.lang.String rowId)
Run a select
-
-
-
Field Detail
-
LOGIN_URL
public static final java.lang.String LOGIN_URL
Login URL- See Also:
- Constant Field Values
-
DATA_PATH
public static final java.lang.String DATA_PATH
Data path- See Also:
- Constant Field Values
-
METADATA_PATH
public static final java.lang.String METADATA_PATH
Metadata path- See Also:
- Constant Field Values
-
SOQL_PATH
public static final java.lang.String SOQL_PATH
Query path- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SalesForceAPITool
public SalesForceAPITool(Grant g, java.lang.String config) throws java.lang.Exception
Constructor- Parameters:
g
- Grantconfig
- Configuration as JSON string- Throws:
java.lang.Exception
-
SalesForceAPITool
public SalesForceAPITool(Grant g, org.json.JSONObject config) throws java.lang.Exception
Constructor- Parameters:
g
- Grantconfig
- Configuration as JSON object- Throws:
java.lang.Exception
-
-
Method Detail
-
getConfig
public org.json.JSONObject getConfig()
Get configuration- Returns:
- Configuration as JSON object
-
metadata
public org.json.JSONObject metadata(java.lang.String name) throws java.lang.Exception
Get object metadata- Parameters:
name
- Object name- Returns:
- Object metadata as JSON object
- Throws:
java.lang.Exception
-
getObjectName
public static java.lang.String getObjectName(org.json.JSONObject md)
Get object name from metadata- Parameters:
md
- Metadata- Returns:
- Field name
-
getFieldName
public static java.lang.String getFieldName(org.json.JSONObject fmd)
Get name from field metadata- Parameters:
fmd
- Field metadata- Returns:
- Field name
-
getFieldLabel
public static java.lang.String getFieldLabel(org.json.JSONObject fmd)
Get label from field metadata and type- Parameters:
fmd
- Field metadata- Returns:
- Field label
-
getFieldHelp
public static java.lang.String getFieldHelp(org.json.JSONObject fmd)
Get help from field metadata and type- Parameters:
fmd
- Field metadata- Returns:
- Field help
-
getFieldType
public static int getFieldType(org.json.JSONObject fmd)
Get type from field metadata- Parameters:
fmd
- Field metadata- Returns:
- Field type (ObjectField.TYPE_*)
-
getFieldSize
public static int getFieldSize(org.json.JSONObject fmd, int type)
Get size from field metadata and type- Parameters:
fmd
- Field metadatatype
- Optional type (obtained from getFieldType), or -1- Returns:
- Field size
-
getFieldDefault
public static java.lang.String getFieldDefault(org.json.JSONObject fmd)
Get default value from field metadata and type- Parameters:
fmd
- Field metadata- Returns:
- Field size
-
getFieldRendering
public static java.lang.String getFieldRendering(org.json.JSONObject fmd, int type)
Get rendering from field metadata and type- Parameters:
fmd
- Field metadatatype
- Optional type (obtained from getFieldType), or -1- Returns:
- Field rendering
-
getFieldReferencedObjectName
public static java.lang.String getFieldReferencedObjectName(org.json.JSONObject fmd)
Get reference to object name from field metadata- Parameters:
fmd
- Field metadata- Returns:
- Reference to object name or null
-
getFieldListOfValues
public static ListOfValuesData getFieldListOfValues(org.json.JSONObject fmd)
Get list of values from field metadata and type- Parameters:
fmd
- Field metadata- Returns:
- Field size
-
getFieldSearch
public static int getFieldSearch(org.json.JSONObject fmd, int type)
Get search mode from field metadata and type- Parameters:
fmd
- Field metadatatype
- Optional type (obtained from getFieldType), or -1- Returns:
- Field size
-
getFieldSearchReq
public static int getFieldSearchReq(org.json.JSONObject fmd, int type, int search)
Get search required from field metadata and type- Parameters:
fmd
- Field metadatatype
- Optional type (obtained from getFieldType), or -1search
- Optional search mode (obtained from getFieldSearch), or -1- Returns:
- Field size
-
isRequired
public static boolean isRequired(org.json.JSONObject fmd, int type)
Is required from field metadata and type- Parameters:
fmd
- Field metadatatype
- Optional type (obtained from getFieldType), or -1- Returns:
- Field size
-
search
public org.json.JSONObject search(java.lang.String query) throws java.lang.Exception
Run a search query- Parameters:
query
- Search query- Returns:
- Search result as JSON object
- Throws:
java.lang.Exception
-
select
public org.json.JSONObject select(java.lang.String name, java.lang.String rowId) throws java.lang.Exception
Run a select- Parameters:
name
- Object namerowId
- Record row ID- Returns:
- Select result as JSON object
- Throws:
java.lang.Exception
-
-