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

com.sas.services.information.metadata
Interface FileInterface

All Superinterfaces:

com.sas.services.information.metadata.DeployedDataPackageInterface, MetadataInterface, PublicObjectInterface, java.rmi.Remote

@SASScope(value="ALL")
@BinaryCompatibilityOnly
public interface FileInterface
extends com.sas.services.information.metadata.DeployedDataPackageInterface

Field Summary

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

abstract void	addDirectory(DirectoryInterface directory) Add a directory to this file's list of associated directories.
abstract void	addScriptedConnection(SASClientConnectionInterface connection) Add a SASClientConnection to the list of connections that this script executes for.
abstract java.util.List	getDirectories() Get the list of Directories associated with this File.
abstract java.lang.String	getFileExtension() Get the file extension.
abstract java.lang.String	getFileName() Get the file name string.
abstract java.util.List	getScriptedConnections() If this is a connection script, get the list of connections it runs for.
abstract java.lang.String	getTextRole() Set the text role for the file.
abstract java.lang.String	getTextType() Get the file's text type.
abstract boolean	isARelativeName() Get the boolean flag indicating if the file name is relative.
abstract void	removeDirectory(DirectoryInterface directory) Remove this file from a Directory.
abstract void	removeScriptedConnection(SASClientConnectionInterface connection) Remove a SASClientConnection from the list of connections that this script executes for.
abstract void	setDirectories(java.util.List directories) Set the list of directories that this file is in.
abstract void	setFileExtension(java.lang.String extension) Set the file extension.
abstract void	setFileName(java.lang.String name) Set the file name string.
abstract void	setIsARelativeName(boolean isRelative) Set the flag indicating the file name is relative to the directory path.
abstract void	setScriptedConnections(java.util.List connections) Set the list of scripted connection this script executes for.
abstract void	setTextRole(java.lang.String textRole) Set the text role for the file.
abstract void	setTextType(java.lang.String textType) Set the file's text type.

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, 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, 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.PublicObjectInterface

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

Method Detail

isARelativeName

boolean isARelativeName()
                        throws ServiceException,
                               java.rmi.RemoteException

Get the boolean flag indicating if the file name is relative.

Returns:

true if the file name is a relative path, false otherwise.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setIsARelativeName

void setIsARelativeName(boolean isRelative)
                        throws ServiceException,
                               java.rmi.RemoteException

Set the flag indicating the file name is relative to the directory path.

Parameters:

isRelative - true if the file name is relative, false otherwise.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getFileName

java.lang.String getFileName()
                             throws ServiceException,
                                    java.rmi.RemoteException

Get the file name string.

Returns:

The file name string.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setFileName

void setFileName(java.lang.String name)
                 throws ServiceException,
                        java.rmi.RemoteException

Set the file name string.

Parameters:

name - The new file name.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getFileExtension

java.lang.String getFileExtension()
                                  throws ServiceException,
                                         java.rmi.RemoteException

Get the file extension.

Returns:

The file extension string.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setFileExtension

void setFileExtension(java.lang.String extension)
                      throws ServiceException,
                             java.rmi.RemoteException

Set the file extension.

Parameters:

extension - The new extension string.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getTextRole

java.lang.String getTextRole()
                             throws ServiceException,
                                    java.rmi.RemoteException

Set the text role for the file.

Returns:

The String with the file's text role.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setTextRole

void setTextRole(java.lang.String textRole)
                 throws ServiceException,
                        java.rmi.RemoteException

Set the text role for the file.

Parameters:

textRole - The text role string.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getTextType

java.lang.String getTextType()
                             throws ServiceException,
                                    java.rmi.RemoteException

Get the file's text type.

Returns:

The file's text type string.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setTextType

void setTextType(java.lang.String textType)
                 throws ServiceException,
                        java.rmi.RemoteException

Set the file's text type.

Parameters:

textType - The file's text type string.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getDirectories

java.util.List getDirectories()
                              throws ServiceException,
                                     java.rmi.RemoteException

Get the list of Directories associated with this File.

Returns:

A List of DirectoryInterface objects associated with this File.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

addDirectory

void addDirectory(DirectoryInterface directory)
                  throws ServiceException,
                         java.rmi.RemoteException

Add a directory to this file's list of associated directories.

Parameters:

directory - A DirectoryInterface object this file is in.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

removeDirectory

void removeDirectory(DirectoryInterface directory)
                     throws ServiceException,
                            java.rmi.RemoteException

Remove this file from a Directory.

Parameters:

directory - A DirectoryInterface object that this File is being removed from.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setDirectories

void setDirectories(java.util.List directories)
                    throws ServiceException,
                           java.rmi.RemoteException

Set the list of directories that this file is in.

Parameters:

directories - A List of DirectoryInterface objects that this file is in.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getScriptedConnections

java.util.List getScriptedConnections()
                                      throws ServiceException,
                                             java.rmi.RemoteException

If this is a connection script, get the list of connections it runs for.

Returns:

A List of SASClientConnectionInterface objects that this script executes for.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

addScriptedConnection

void addScriptedConnection(SASClientConnectionInterface connection)
                           throws ServiceException,
                                  java.rmi.RemoteException

Add a SASClientConnection to the list of connections that this script executes for.

Parameters:

connection - A new connection to add to the scripted connections list.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

removeScriptedConnection

void removeScriptedConnection(SASClientConnectionInterface connection)
                              throws ServiceException,
                                     java.rmi.RemoteException

Remove a SASClientConnection from the list of connections that this script executes for.

Parameters:

connection - The connection to remove from the scripted connections list.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setScriptedConnections

void setScriptedConnections(java.util.List connections)
                            throws ServiceException,
                                   java.rmi.RemoteException

Set the list of scripted connection this script executes for.

Parameters:

connections - The list of SASClientConnectionInterface objects that this file acts as a script for.

Throws:

ServiceException - If a server error occurs.

java.rmi.RemoteException - In the event of remote object failure.

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