Package com.sas.services.information.metadata.favorites

Interface FavoritesGroup

All Superinterfaces:
FavoritesContainer, MetadataInterface, PublicObjectContainerInterface, PublicObjectInterface, Remote
public interface FavoritesGroup extends FavoritesContainer
Interface representing the FavoritesGroup public object. The purpose of this object type is to allow users to organize their favorites into multiple categories.

This interface behaves just like a FavoritesFolder. The only different between the two is that a FavoritesGroup is considered to be a nested public object. It is contained only by a FavoritesFolder or another FavoritesGroup. A FavoritesGroup instance can never be parented directly by a folder.

To create a new favorites group object, the FavoritesFactory class should be used. The following is an example of how to create a new favorites group under an existing favorites folder: 

  
  String name = "WRS Favorites";
  FavoritesFolder favoritesFolder = null;
  FavoritesGroup favoritesGroup = FavoritesFactory.createFavoritesGroup(name, favoritesFolder); 
  if (favoritesGroup != null)
  {
     //persist the changes to the server
     favoritesGroup.update();
  }
Since:
9.3

  • Method Details