Storing results for later use
The client should store the results for most operations executed
during a CARMA session, especially the results from browsing functions
such as getMembers
and getInstances
. All instances,
simple members, and containers have both an ID and a display name.
The display name is what the client should display to the user. The
display name for an entity should be given in the context of that
entity's instance and, if applicable, all parent containers needed
to reach that entity. The ID defines the entity to the RAM uniquely.
For example, the entity's ID could simply contain its absolute path.
Alternatively, the RAM could use a hashing function to obtain the
entity's absolute path from the ID. The ID should be stored by the
client so that it can be passed back to the RAM as needed. For example,
a user might obtain a list of members within an instance and then
check to see if one of those members is a container.
The other pieces of data that might need to be stored by the client (if they are not already known) are metadata keys, RAM CAF information, and names. The RAM CAF information is required by virtually every function that uses a RAM to carry out an operation.The CAF information that is required may be as simple as the ID of the RAM the action should be run by.