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

com.sas.services.publish.metadata
Interface ArchiveInterface

All Superinterfaces:

MetadataInterface, PackageInterface,

All Known Implementing Classes:

public interface ArchiveInterface

extends PackageInterface

This is a generic interface to represent a published SAS package persisted to a file system.

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

PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

void	setAbstract(String text) Set the archive abstract.
void	setChannel(ChannelInterface channel) Set the Channel that this Archive belongs to.
void	setCreationDate(long date) Set the creation date for an archive.
void	setDescription(String text) Set the Archive description.
void	setDirectory(DirectoryInterface directory) Set the directory this archive exists in.
void	setExpirationDate(long date) Set the expiration date for an archive.
void	setName(String name) Set the name of the archive.
void	setProperties(AttributeMapInterface map) Set the name/value pairs on the Archive.
void	setPublisher(PersonInterface publisher) Set the identity of the person who performed the publish.

Methods inherited from interface com.sas.services.publish.metadata.PackageInterface

getAbstract, getChannel, getContentDestination, getCreationDate, getCreationDateString, getExpirationDate, getExpirationDateString, getProperties, getPublisher, getPublisherAlias

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, setGUID, setKeywords, setPermission, setRemarksList, setRepository, startTransaction, transactionEvent, uncheckout, update, version

Method Detail

setChannel

public void setChannel(ChannelInterface channel)
                throws ServiceException,
                       RemoteException

Set the Channel that this Archive belongs to. This can only be done once. If the Channel has already been set, this method will throw an IllegalStateException.

setAbstract

public void setAbstract(String text)
                 throws RemoteException

Set the archive abstract. This is a longer description of the contents of the archive.

setDescription

public void setDescription(String text)
                    throws RemoteException

Set the Archive description.

Specified by:

setDescription in interface MetadataInterface

Following copied from interface: com.sas.services.information.metadata.MetadataInterface

Parameters:

description - The object description.

Throws:

RemoteException - if an error occurs

setName

public void setName(String name)
             throws RemoteException

Set the name of the archive. This name should be unique among archives.

Specified by:

setName in interface MetadataInterface

Following copied from interface: com.sas.services.information.metadata.MetadataInterface

Parameters:

name - a String for the object name.

Throws:

RemoteException - if an error occurs

setProperties

public void setProperties(AttributeMapInterface map)
                   throws RemoteException

Set the name/value pairs on the Archive.

setCreationDate

public void setCreationDate(long date)
                     throws RemoteException

Set the creation date for an archive.

Parameters:

date - A long representing the creation date/time of the archive file.

Throws:

RemoteException - in the event of remote object failure

setExpirationDate

public void setExpirationDate(long date)
                       throws RemoteException

Set the expiration date for an archive.

Parameters:

date - A long representing the expiration date/time of the archive file.

Throws:

RemoteException - in the event of remote object failure.

setDirectory

public void setDirectory(DirectoryInterface directory)
                  throws RemoteException

Set the directory this archive exists in.

Parameters:

directory - A Directory object this archive is contained in.

Throws:

RemoteException - in the event of remote object failure.

setPublisher

public void setPublisher(PersonInterface publisher)
                  throws RemoteException

Set the identity of the person who performed the publish.

Parameters:

publisher - The person who published the archive.

Throws:

RemoteException - in the event of remote object failure.

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