Package com.sas.metadata.remote

Interface FavoritesContainer

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface FavoritesContainer extends PrimaryType
Contains one or more links to an object that a user has marked as a favorite.

Attributes of FavoritesContainer are:

Associations of FavoritesContainer are:

Usage

To create an instance of this FavoritesContainer, use the factory create methods.
Example: create a FavoritesContainer with name "FavoritesContainer_Object", in repository "AAAAAAAA".
 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 FavoritesContainer myObject = (FavoritesContainer) factory.createComplexMetadataObject(objectStore, "FavoritesContainer_Object", MetadataObjects.FAVORITESCONTAINER, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed

Behavior

  • Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
  • When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
  • If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:
9.0