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

com.sas.services.publish
Interface EntryInterface

All Superinterfaces:

com.sas.entities.EntityKeyInterface, java.rmi.Remote

All Known Subinterfaces:

BinaryFileEntryInterface, DatasetEntryInterface, HTMLEntryInterface, LibraryMemberEntryInterface, ReferenceEntryInterface, ResultPackageInterface, TextFileEntryInterface, ViewerEntryInterface

All Known Implementing Classes:

AbstractEntry, BinaryFileEntry, HTMLEntry, ReferenceEntry, ResultPackage, TextFileEntry, ViewerEntry

public interface EntryInterface
extends java.rmi.Remote, com.sas.entities.EntityKeyInterface

The EntryInterface provides a mechanism for getting and setting the attributes of a result package or result package entry.

Since:

1.0

Method Summary

java.lang.String	getDescription() Returns the description.
AttributeMapInterface	getNameValuePairs() Returns the name/value pairs.
java.lang.String	getURL() Returns the URL string that identifies the entry.
boolean	isReadOnly() Returns true when the entry or package is read only.
void	setDescription(java.lang.String description) Set the description.
void	setNameValuePairs(AttributeMapInterface namevalues) Sets the name/value pairs.

Method Detail

getDescription

java.lang.String getDescription()
                                throws java.lang.IllegalStateException,
                                       java.rmi.RemoteException

Returns the description.

Returns:

String The description.

Throws:

java.lang.IllegalStateException - If the result package has already been closed.

java.rmi.RemoteException - If a network anomaly is encountered.

setDescription

void setDescription(java.lang.String description)
                    throws java.lang.IllegalStateException,
                           java.rmi.RemoteException

Set the description.

Parameters:

description - The description.

Throws:

java.lang.IllegalStateException - If the entry or package is read only or if the result package has already been closed.

java.rmi.RemoteException - If a network anomaly is encountered.

getNameValuePairs

AttributeMapInterface getNameValuePairs()
                                        throws java.lang.IllegalStateException,
                                               TransportException,
                                               java.rmi.RemoteException

Returns the name/value pairs. At publish time, user-specified name/value pairs may be associated with a result package or its entries.

Returns:

AttributeMapInterface The name values; may be null.

Throws:

java.lang.IllegalStateException - If the result package has already been closed.

TransportException - If the transport encounters an error getting name value pairs.

java.rmi.RemoteException - If a network anomaly is encountered.

setNameValuePairs

void setNameValuePairs(AttributeMapInterface namevalues)
                       throws java.lang.IllegalStateException,
                              java.rmi.RemoteException

Sets the name/value pairs. These name/value pairs provide user or application control information describing the package or entry.

Parameters:

namevalues - The name/value pairs.

Throws:

java.lang.IllegalStateException - If the entry or package is read only or if the result package has already been closed.

java.rmi.RemoteException - If a network anomaly is encountered.

isReadOnly

boolean isReadOnly()
                   throws java.lang.IllegalStateException,
                          java.rmi.RemoteException

Returns true when the entry or package is read only. This occurs when the result package is an existing package that has been retrieved. Entries are read only if they belong to a package that is being retrieved.

Returns:

boolean True if read only; otherwise if this is a new entry/package under construction, false is returned.

Throws:

java.lang.IllegalStateException - If the result package has already been closed.

java.rmi.RemoteException - If a network anomaly is encountered.

getURL

java.lang.String getURL()
                        throws java.lang.IllegalStateException,
                               TransportException,
                               java.rmi.RemoteException

Returns the URL string that identifies the entry.

Returns:

String The URL string; may be null.

Throws:

java.lang.IllegalStateException - If the result package has already been closed.

TransportException - If the transport encounters an error obtaining the URL.

java.rmi.RemoteException - If a network anomaly is encountered.

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