PreferenceObjectService Methods TIBCO Spotfire 7.6 API Reference

The PreferenceObjectService type exposes the following members.

Methods

  Name Description
Public method AddT
Adds a PreferenceObjectT to the current user's personal defined set of objects. The added object will be stored locally until synchronized with the server, which occurs immediately if the application is connected to the server, or at the next login if it is not.

Note that the preference object being added must be globally unique identified by its class and its name. If an object with the same name already has been added, the object is only added to the local cache and never synchronized with the server.

Public method AddApplicationDefaultT
Public method ApplyChangesT
Applies changes made to a PreferenceObjectT in the current users own defined set of preference objects. Note that this call requires the object to have previously been added to the user's preferences.
Public method Exists
Checks whether or not a preference object exists.
Public method Static member ExportPreferenceObjectT
Persists a PreferenceObjectT to file. Note that the Preference Object will not be added to the current user's set of object by calling this method; it will only be stored to file.

The export mechanism is based on the .Net XML serialization and therefore it is required of type T to implement all prerequisites for such serialization to be possible.

Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method FindT
Finds the one and only PreferenceObjectT in the class defined by className that has the same value as value and the id as objectId. If no such object is not found, the first object in the class that has the same value as T will be returned even if it doesn't have the same id as objectId. If no object with the same value as T is found, a default object defined for the class will be returned.
Public method FindAllT
Finds all Preference Objects in the class defined by className that have the same value as value and returns the identifiers of the objects found. Note that it is very important for the type T to override the Equals(Object) method with an appropriate implementation, since that implementation alone affects the objects will match the given search condition object, value.
Public method GetAllObjectNames
Gets the names of all preference objects for the Preference Class given by className, including the application default object.
Public method GetDefaultObjectNameT
Public method GetObjectT
Gets one specific PreferenceObjectT with the identity defined by objectId. The retrieval is performed according to the following sets of rules: If the requested preference object is found, return it.Else, if there is a user defined default object, return it.Else, if there is a group level defined default object, return it. If the user is a member of more than one group, an individual group order determines which default preference object to use. Else, if there is an application default object, return it.Else, throw exception.
Public method GetObjectsT
Gets all preference objects of a specified class defined by className.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method RemoveT
Removes a preference object from the current users own defined set of objects.
Top
See Also

Reference