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

com.sas.services.publish.metadata
Interface PackageInterface

All Superinterfaces:
MetadataInterface,
All Known Subinterfaces:
ArchiveInterface, DavBinaryPackageInterface
All Known Implementing Classes:

public interface PackageInterface
extends MetadataInterface

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
 String getAbstract()
          Get the package abstract.
 ChannelInterface getChannel()
          Get the Channel that this archive belongs to, if any.
 ContentDestination getContentDestination()
          Get the ContentDestination that represents the content data.
 long getCreationDate()
          Get the date the package was created.
 String getCreationDateString()
          Get a formatted string representing the date and time the package was created.
 long getExpirationDate()
          Get the expiration date of the package.
 String getExpirationDateString()
          Get the expiration date of the package.
 AttributeMapInterface getProperties()
          Get the name/value pairs for this package.
 PersonInterface getPublisher()
          Get a com.sas.services.information.metadata.Person object which represents the publisher of the package.
 String getPublisherAlias()
          Get the alias information for the publisher.
 
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

getChannel

public ChannelInterface getChannel()
                            throws ServiceException,
                                   RemoteException
Get the Channel that this archive belongs to, if any.

getPublisher

public PersonInterface getPublisher()
                             throws RemoteException
Get a com.sas.services.information.metadata.Person object which represents the publisher of the package.

Returns:
The Person who published the package.
Throws:
RemoteException - in the event of remote object failure.

getPublisherAlias

public String getPublisherAlias()
                         throws RemoteException
Get the alias information for the publisher. This String is in the form of "userAccountName" "personName". The first quoted value is the proccess id (name) of the publisher. This is followed by a space, and then another quoted value which is the name of the person that published the package. If the name of the person was not available, this second quoted value will be the user name used to publish the package.

Returns:
A String containing the publisher alias information.
Throws:
RemoteException - in the event of remote object failure.

getContentDestination

public ContentDestination getContentDestination()
                                         throws RemoteException
Get the ContentDestination that represents the content data.

Returns:
A ContentDestination which has the file system or server information.
Throws:
RemoteException - in the event of a remote object failure.

getCreationDate

public long getCreationDate()
                     throws RemoteException
Get the date the package was created.

Returns:
The package creation date and time.

getCreationDateString

public String getCreationDateString()
                             throws RemoteException
Get a formatted string representing the date and time the package was created.

Returns:
A string representing the date the package was created.

getExpirationDate

public long getExpirationDate()
                       throws RemoteException
Get the expiration date of the package.

Returns:
The date and time the package expires and the data it contains should be considered obsolete.

getExpirationDateString

public String getExpirationDateString()
                               throws RemoteException
Get the expiration date of the package. The date is returned as a formatted string.

Returns:
The date and time the package expires and the data it contains should be considered obsolete.

getAbstract

public String getAbstract()
                   throws RemoteException
Get the package abstract. The abstract is a more detailed description of the contents of the package.

Returns:
The package abstract.

getProperties

public AttributeMapInterface getProperties()
                                    throws RemoteException
Get the name/value pairs for this package.

Returns:
A Map of name/value pairs that describe this package.

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




Copyright © 2006 SAS Institute Inc. All Rights Reserved.
javadoc generated Fri, 10 Feb 2006 17:29:02