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

Interface FavoritesFolder

All Superinterfaces:
FavoritesContainer, MetadataInterface, PublicObjectContainerInterface, PublicObjectInterface, Remote
public interface FavoritesFolder extends FavoritesContainer
Interface representing the FavoritesFolder public object. A favorites folder is used by an application to implement features like favorites or history or may visible to the user as a tool for collecting objects of interest into a common view.

This interface operates similarly to other interfaces in the standard Collections framework and provides methods used to retrieve the contents of a favorites folder, as well as adding and removing "favorite" public objects. The members or contents of a FavoritesFolder may consist of public objects contained by a folder or nested FavoritesGroup objects.

To create a new favorites folder, the FavoritesFactory class should be used. The following is an example of how to create a new favorites folder under a user's "My Folder" location: 

  
  String name = "Favorites";
  FolderInterface myFolder = server.getHomeFolder(null, UserFolderType.FOLDERTYPE_MYFOLDER, null);
  FavoritesFolder favoritesFolder = FavoritesFactory.createFavoritesFolder(name, myFolder); 
  if (favoritesFolder != null)
  {
     //persist the changes to the server
     favoritesFolder.update();
  }
Since:
9.3