DBSObject class documentation

Authors

Riccardo Mottola

Copyright: (C) 2010-2016 Free Software Foundation

Software documentation for the DBSObject class

DBSObject : NSObject

Declared in:
DBSObject.h
Conforms to:
NSCopying
Description forthcoming.

Instance Variables

Method summary

idTo18: 

+ (NSString*) idTo18: (NSString*)id15;
returns the 18-char version of the 15-char id

Returns the corresponding 18-character case-insensitive salesforce Id given the 15-character version id15

Returns the corresponding 18-character case-insensitive salesforce Id given the 15-character version id15


fieldNames 

- (NSArray*) fieldNames;

Returns a list of all known field names.


keyPrefix 

- (NSString*) keyPrefix;
shortcut to return the property "keyPrefix"

label 

- (NSString*) label;
shortcut to return the property "label"

loadFieldValues 

- (void) loadFieldValues;

Loads or refreshes the value of all known fields to the object.

If the object is instantiated as a result of a describe, it will load all values.

The object needs to have a valid DBSoap instance set


loadValuesForFields: 

- (void) loadValuesForFields: (NSArray*)namesArray;

Loads or refreshes the value of the fields passed in the array.


name 

- (NSString*) name;
shortcut to return the property "name"

objectProperties 

- (NSDictionary*) objectProperties;
returns the properties of the object itself, like its name

propertiesOfField: 

- (NSDictionary*) propertiesOfField: (NSString*)field;
Description forthcoming.

recordTypes 

- (NSArray*) recordTypes;
returns information about the Object RecordTypes

removeField: 

- (void) removeField: (NSString*)field;
removes a field and its properties

setDBSoap: 

- (void) setDBSoap: (DBSoap*)db;
Set the soap database interface

setObjectProperties: 

- (void) setObjectProperties: (NSDictionary*)properties;
sets the properties of the object itself

setProperties: forField: 

- (void) setProperties: (NSDictionary*)properties forField: (NSString*)field;
Description forthcoming.

setRecordTypes: 

- (void) setRecordTypes: (NSArray*)rtInfo;
Description forthcoming.

setValue: forField: 

- (void) setValue: (id)value forField: (NSString*)field;

Sets the value of the given field of the record and adds it to the list if field names if it was not already present.


sfId 

- (NSString*) sfId;
returns the salesforce Id of the object in whichever format it is

returns the current salesforce id, in whichever format it is currently stored.

returns the current salesforce id, in whichever format it is currently stored.


sfId15 

- (NSString*) sfId15;
returns the salesforce Id of the object, always in the 15-char case-sensitive version

Returns the current salesforce Id, always in the 15-character case-sensitive format, converting it if necessary.

Returns the current salesforce Id, always in the 15-character case-sensitive format, converting it if necessary.


sfId18 

- (NSString*) sfId18;
returns the salesforce Id of the object, always in the 18-char case-insensitive version

Returns the current salesforce Id, always in the 18-character case-insensitive format, converting it if necessary.

Returns the current salesforce Id, always in the 18-character case-insensitive format, converting it if necessary.


storeValuesForFields: 

- (void) storeValuesForFields: (NSArray*)namesArray;

Stores by updating the value of the fields passed in the array.


type 

- (NSString*) type;
shortcut to return the property "type"

valueForField: 

- (id) valueForField: (NSString*)field;

Returns the value of field field




Instance Variables for DBSObject Class

dbs

@protected DBSoap* dbs;
Description forthcoming.

fieldNames

@protected NSMutableArray* fieldNames;
Description forthcoming.

fieldProperties

@protected NSMutableDictionary* fieldProperties;
Description forthcoming.

objectProperties

@protected NSMutableDictionary* objectProperties;
Description forthcoming.

recordTypes

@protected NSArray* recordTypes;
Description forthcoming.

recordValues

@protected NSMutableDictionary* recordValues;
Description forthcoming.