Getting Entity objects
To
obtain an existing Entity object whose ID you know, you can use the Session
object's GetEntity or GetEntityByDbId methods.
If you do not know the ID of the record, you can use the Session object's BuildQuery method
to create a query and search for records that match a desired set of criteria.
Entity objects found using these techniques are read-only. To edit an Entity
object, you must call the Session object's EditEntity method.
After you acquire an Entity object, you can call its methods
to perform tasks such as the following:
Note: The methods listed here is a
sample of the methods you can use for each task. It is not a complete list
of all methods you can use.
- Task
- Entity Object methods you can use
- Examine or modify the values of a field
- Validate and commit the record
Validate,Commit- Determine which fields must be filled in by the user
GetFieldRequiredness- Determine the acceptable values for each field, and which fields have incorrect values
- Determine which fields have been updated
GetFieldsUpdatedThisAction,GetFieldsUpdatedThisGroup,GetFieldsUpdatedThisSetValue- Find other data records that are considered duplicates of this one
GetDuplicates- Find the original data record, if this one is a duplicate
GetFieldOriginalValue