com.sas.services.information.metadata.favorites
Interface FavoritesFolder

All Superinterfaces:

FavoritesContainer, MetadataInterface, PublicObjectContainerInterface, PublicObjectInterface, java.rmi.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

Field Summary

Fields inherited from interface com.sas.services.information.metadata.favorites.FavoritesContainer

CAPACITY_UNLIMITED

Fields inherited from interface com.sas.services.information.metadata.MetadataInterface

METADATA_STATE_DELETED, METADATA_STATE_DESTROYED, METADATA_STATE_NEW, METADATA_STATE_NORMAL, PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

Methods inherited from interface com.sas.services.information.metadata.favorites.FavoritesContainer

addFavorite, addFavoritesGroup, containsFavorite, getFavoriteCount, getFavoriteIndex, getFavorites, getFavorites, getFavoritesGroupIndex, getFavoritesGroups, getMaxCapacity, getTotalFavoriteCount, hasDuplicateFavoritesGroup, insertFavorite, insertFavoritesGroup, isEmpty, moveFavorite, removeAll, removeAllFavorites, removeAllFavoritesGroups, removeFavorite, removeFavoritesGroup, setMaxCapacity

Methods inherited from interface com.sas.services.information.metadata.MetadataInterface

add, addAccessControl, addAttribute, addAttributes, addDocument, addExtension, addGroup, addImplementor, addKeyword, addObjectProperty, addObjectProperty, addPermissions, addPrompt, addPropertySet, addRemark, addResponsibleParty, addTransactionListener, addUsedByPrototype, checkin, checkout, commit, copyTo, countAssociatedObjects, delete, deleteAttribute, deleteAttributes, destroy, getAccessControls, getAttribute, getAttributes, getAuthorizationUtil, getCreateDate, getDescription, getDocuments, getEntityKey, getEntityURL, getExtensions, getGroups, getGUID, getIdentities, getImplementors, getKeywords, getLockedBy, getModifyDate, getObjectProperties, getParent, getParentPath, getParents, getPath, getPaths, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getPrimaryPropertyGroup, getPrompt, getPrompts, getPropertyBag, getPropertySets, getRemarksList, getReposId, getRepository, getRepositoryEntity, getRepositoryName, getReposKey, getResponsibleParties, getState, getTrackingId, getType, getUsageVersion, getUsedByPrototypes, getUsingPrototype, getVersion, isAuthorized, isCompatible, isDeleted, isDestroyed, isLoggingEnabled, isObjectAlive, isReadCompatible, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeDocument, removeExtension, removeGroup, removeImplementor, removeKeyword, removeObjectProperty, removePermissions, removePrompt, removePropertySet, removeResponsibleParty, removeUsedByPrototype, rollback, setAttribute, setAttributes, setDeleted, setDescription, setDocuments, setExtensions, setGroups, setGUID, setKeywords, setName, setObjectProperties, setPermission, setPrimaryPropertyGroup, setPrompt, setPrompts, setRemarksList, setRepository, setUsingPrototype, startTransaction, toByteArray, transactionEvent, uncheckout, update, updateFromBag, version

Methods inherited from interface com.sas.services.information.publicobject.PublicObjectContainerInterface

getChildAt, getChildCount, getChildren, getChildren, newChild

Methods inherited from interface com.sas.services.information.publicobject.PublicObjectInterface

addProcessorInterface, getContainer, getIdentifier, getName, getObjectURI, getPathUrl, getProcessorInterface, getTypeDescriptor