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

com.sas.services.information.metadata
Interface DirectoryInterface

All Superinterfaces:

MetadataInterface,

All Known Subinterfaces:

PublishDirectoryInterface

All Known Implementing Classes:

LdapDirectory, OMRDirectory,

public interface DirectoryInterface

extends MetadataInterface

This interface represents a repository neutral accessor class for a Directory object in a metadata repository.

Since:

1.0

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

PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

void	addFile(MetadataInterface file) Add a file to this directory.
void	addServer(MetadataInterface server) Add a server to the list that has access to this directory.
String	getFilePath() Return the path string for this directory.
List	getFiles() Get a list of files in this directory.
List	getServers() Get a list of servers that are associated with this directory.
boolean	isBasePath() Get flag indicating if this Directory is an HTTP server base path
boolean	isDavEnabled() Get flag indicating if this Directory is DAV enabled.
void	removeFile(MetadataInterface file) Remove a file from this directory.
void	removeServer(MetadataInterface server) Remove a server from the list that has access to this Directory.
void	setIsBasePath(boolean value) Set the flag indicating if this Directory is a valid base for an HTTP server.
void	setIsDavEnabled(boolean value) Set the flag indicating if this directory is DAV enabled.
void	setPath(String path) Set the path string for the directory.

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

add, addAccessControl, addAttribute, addAttributes, addExtension, addKeyword, addPermissions, addRemark, addTransactionListener, checkin, checkout, commit, copyTo, delete, deleteAttribute, deleteAttributes, getAccessControls, getAttribute, getAttributes, getCreateDate, getDescription, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentities, getKeywords, getModifyDate, getName, getParentPath, getParents, getPath, getPaths, getPathUrl, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getRemarksList, getReposId, getRepository, getRepositoryEntity, getReposKey, getTrackingId, getType, getVersion, isAuthorized, isLoggingEnabled, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeExtension, removeKeyword, removePermissions, rollback, setAttribute, setAttributes, setDescription, setGUID, setKeywords, setName, setPermission, setRemarksList, setRepository, startTransaction, transactionEvent, uncheckout, update, version

Method Detail

getFilePath

public String getFilePath()
                   throws ServiceException,
                          RemoteException

Return the path string for this directory.

Returns:

The path.

Throws:

ServiceException - if a repository error occurs

RemoteException - in the event of remote object failure.

setPath

public void setPath(String path)
             throws ServiceException,
                    RemoteException

Set the path string for the directory.

Parameters:

path - The new path string.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

getFiles

public List getFiles()
              throws ServiceException,
                     RemoteException

Get a list of files in this directory. Of course, this is a list of files that appear in the metadata repository, not necessarily what's on the file system.

Returns:

A List of MetadataInterface objects representing the files that are in the directory. Some may be Archives, but others may not be.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

addFile

public void addFile(MetadataInterface file)
             throws ServiceException,
                    RemoteException

Add a file to this directory.

Parameters:

file - a new file to add to this directory.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

removeFile

public void removeFile(MetadataInterface file)
                throws ServiceException,
                       RemoteException

Remove a file from this directory.

Parameters:

file - A file to remove.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of a remote object failure.

getServers

public List getServers()
                throws ServiceException,
                       RemoteException

Get a list of servers that are associated with this directory. Hopefully, this association means that the server are able to access the contents of the directory.

Returns:

A List of Server objects that are defined to have access to the contents of this directory.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

addServer

public void addServer(MetadataInterface server)
               throws ServiceException,
                      RemoteException

Add a server to the list that has access to this directory.

Parameters:

server - A new server to add to the list for this directory.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

removeServer

public void removeServer(MetadataInterface server)
                  throws ServiceException,
                         RemoteException

Remove a server from the list that has access to this Directory.

Parameters:

server - A server to remove from the list that can access this directory.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

isBasePath

public boolean isBasePath()
                   throws RemoteException

Get flag indicating if this Directory is an HTTP server base path

Returns:

true if this is a valid base path for an HTTP server.

Throws:

RemoteException - in the event of remote object failure.

setIsBasePath

public void setIsBasePath(boolean value)
                   throws RemoteException

Set the flag indicating if this Directory is a valid base for an HTTP server.

Parameters:

value - true if this Directory can be used by an HTTP server as a base.

Throws:

RemoteException - in the event of remote object failure.

isDavEnabled

public boolean isDavEnabled()
                     throws RemoteException

Get flag indicating if this Directory is DAV enabled.

Returns:

true if this Directory supports DAV access.

Throws:

RemoteException - in the event of remote object failure.

setIsDavEnabled

public void setIsDavEnabled(boolean value)
                     throws RemoteException

Set the flag indicating if this directory is DAV enabled.

Parameters:

value - true if this directory can be accessed via the DAV protocol.

Throws:

RemoteException - in the event of remote object failure.

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