Package com.sas.services.information.metadata

# Interface FolderAdminInterface

public interface FolderAdminInterface
The interface used for administrative functions with the SAS Folders tree.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `RootFolderInterface`
  `createRepositoryRootFolder(OMIRepositoryInterface repos)`
  Creates the root folder for a repository.
  `FolderInterface`
  `createTopLevelFolder(OMIRepositoryInterface repos, String folderName)`
  Creates a new top level folder for the given repository or returns an existing folder that has already been defined.

- ## Method Details

  - ### createTopLevelFolder

    FolderInterface createTopLevelFolder(OMIRepositoryInterface repos, String folderName) throws ServiceException, RemoteException
    Creates a new top level folder for the given repository or returns an existing folder that has already been defined.

    The name of the folder passed in must be valid. Callers should ensure that the `FolderUtil.makeValidFolderName(String, FolderInterface, MetadataNameConstraint)` method is called first, before calling this method.

    Parameters:
      `repos` - the repository the folder will exist under
      `folderName` - the name to use for the folder
    Returns:
      the top level folder associated with a repository
    Throws:
      `ServiceException`
      `RemoteException`

  - ### createRepositoryRootFolder

    RootFolderInterface createRepositoryRootFolder(OMIRepositoryInterface repos) throws ServiceException, RemoteException
    Creates the root folder for a repository.
    Parameters:
      `repos` - the repository
    Returns:
      the root folder
    Throws:
      `ServiceException`
      `RemoteException`