*** This interface provides Binary Compatibility only, not Source Compatibility ***

Package com.sas.services.information.metadata

Interface VirtualFolderInterface

All Superinterfaces:

FolderInterface, MetadataInterface, MutableContainerInterface, PublicObjectContainerInterface, PublicObjectInterface, Remote

All Known Implementing Classes:

ServerVirtualFolder, VirtualFolder

@SASScope("ALL")
@BinaryCompatibilityOnly
public interface VirtualFolderInterface
extends FolderInterface

Interface used to model a virtual folder contained within the SAS Folders tree. A virtual folder looks just like a regular folder, and in fact this interface extends from FolderInterface. However, a virtual folder does not exist in metadata. These objects are actually generated dynamically by the client and are thought of as an "in-memory" object.

Because a virtual folder does not exist within metadata, there are many operations that cannot be performed that are typically used by other smart objects, including folders. This means that a virtual folder cannot have permissions set on it, it cannot be renamed, and it cannot be deleted.

A virtual folder will only exist within a repository's System folder. Each virtual folder in the repository can only contain either nested virtual folders or public objects that are not normally contained by other public objects, including a folder. An example of objects that can be found under a virtual folder includes Users and Server definitions.

Since:

9.3

Field Summary

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

FOLDER_TYPE_BIP

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

Modifier and Type	Method	Description
void	addSubfolder(VirtualFolderInterface folder)	Adds a nested virtual folder.
Search	getSearchManager()	Returns the search manager that is used to populate the contents of a virtual folder.

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

addItem, addNewItem, addSubfolder, deleteItem, deleteSubfolder, getContentCreateDate, getContentInfo, getContentModifyDate, getFolderType, getItem, getItemByClass, getItemByType, getItems, getItemsByClass, getItemsByType, getItemSublist, getItemSublist, getParent, getPath, getPublicTypeItem, getSubfolder, getSubfolders, getTotalNumberOfItems, hasDuplicate, hasDuplicateSubfolder, isEmpty, isItemNameUnique, makeSubfolder, makeSubfolder, moveMembersOnOverflow, removeItem, removeSubfolder, setContentCreateDate, setContentModifyDate, setFolderType

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

add, addAccessControl, addAttribute, addAttributes, addDocument, addExtension, addGroup, addImplementor, addKeyword, addNoteTextStore, addNoteTextStore, addObjectProperty, addObjectProperty, addPermissions, addPrompt, addPropertySet, addRemark, addResponsibleParty, addTransactionListener, addUsedByPrototype, checkin, checkout, commit, copyTo, countAssociatedObjects, delete, deleteAttribute, deleteAttributes, destroy, getAccessControls, getAttribute, getAttributes, getAuthorizationUtil, getCreateDate, getCreatedBy, getDescription, getDocuments, getEntityKey, getEntityURL, getExtensions, getGroups, getGUID, getIdentities, getImplementors, getKeywords, getLockedBy, getModifiedBy, getModifyDate, getNoteTextStore, getNoteTextStores, getNoteTextStoresByRole, getObjectProperties, 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, isObjectAlive, isReadCompatible, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeDocument, removeExtension, removeGroup, removeImplementor, removeKeyword, removeNoteTextStore, removeObjectProperty, removePermissions, removePrompt, removePropertySet, removeResponsibleParty, removeResponsiblePartyByIdentity, removeUsedByPrototype, rollback, setAttribute, setAttributes, setDeleted, setDescription, setDocuments, setExtensions, setGroups, setGUID, setKeywords, setName, setNoteTextStores, setObjectProperties, setPermission, setPrimaryPropertyGroup, setPrompt, setPrompts, setRemarksList, setRepository, setUsingPrototype, startTransaction, toByteArray, transactionEvent, uncheckout, update, updateFromBag, version

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

addChild, insertChild, removeChild

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

Method Details

addSubfolder

void addSubfolder(VirtualFolderInterface folder)
           throws ServiceException,
RemoteException

Adds a nested virtual folder.

Parameters:

folder - a sub or nested virtual folder

getSearchManager

Search getSearchManager()
                 throws ServiceException,
RemoteException

Returns the search manager that is used to populate the contents of a virtual folder.

Returns:

search manager