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

com.sas.services.publish
Class ReferenceEntry

com.sas.services.publish.ReferenceEntry

All Implemented Interfaces:

com.sas.entities.EntityKeyInterface, EntryInterface, ReferenceEntryInterface, java.io.Serializable, java.rmi.Remote

public class ReferenceEntry
implements ReferenceEntryInterface

Represents a reference entry that can then be added to a result package for publishing. A reference entry simply identifies (references) some data or file (such as a web page) that is external to the package. See Constructing a Result Package to Publish for an example of how this class is used.

Since:

1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sas.services.publish.AbstractEntry

BINARY_COMPAT_VERSION, CATALOG_COMPAT_VERSION, DATASET_COMPAT_VERSION, DEFAULT_ENTRY_VERSION, HTML_COMPAT_VERSION, MDDB_COMPAT_VERSION, NESTEDPACKAGE_COMPAT_VERSION, REFERENCE_COMPAT_VERSION, SQLVIEW_COMPAT_VERSION, TEXT_COMPAT_VERSION, VIEWER_COMPAT_VERSION

Fields inherited from interface com.sas.services.publish.ReferenceEntryInterface

HTML_REFERENCE, URL_REFERENCE

Constructor Summary

	ReferenceEntry() Creates a default instance.
protected	ReferenceEntry(java.lang.Class theClass) Creates a new reference entry.
	ReferenceEntry(java.lang.String reference, java.lang.String referenceType) Creates a new reference entry.

Method Summary

java.lang.String	getReference() Returns the reference string.
java.lang.String	getReferenceType() Returns the type of reference.
void	setReference(java.lang.String reference) Sets the reference string.
void	setReferenceType(java.lang.String referenceType) Sets type of reference.

Methods inherited from class com.sas.services.publish.AbstractEntry

getDescription, getEntityKey, getNameValuePairs, getURL, isClosed, isReadOnly, sameEntity, setClosed, setDescription, setEntityKey, setNameValuePairs, setRead, throwExceptionIfClosed

Methods inherited from interface com.sas.services.publish.EntryInterface

getDescription, getNameValuePairs, getURL, isReadOnly, setDescription, setNameValuePairs

Constructor Detail

ReferenceEntry

public ReferenceEntry()
               throws java.rmi.RemoteException

Creates a default instance. This constructor should not be used and is only provided sine the compiler was previously providing a default public constructor. Use {#ReferenceEntry(String reference, String referenceType)} instead.

Throws:

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

ReferenceEntry

protected ReferenceEntry(java.lang.Class theClass)
                  throws java.rmi.RemoteException

Creates a new reference entry.

Parameters:

theClass - The class to use when determine which RMI socket factories are to be used when exporting a remote object.

Throws:

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

ReferenceEntry

public ReferenceEntry(java.lang.String reference,
                      java.lang.String referenceType)
               throws java.rmi.RemoteException,
                      java.lang.IllegalArgumentException

Creates a new reference entry.

Parameters:

reference - The reference which identifies some data or file that is external to the package, such as a url.

referenceType - The type of reference. Support reference types include HTML or URL.

Throws:

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

java.lang.IllegalArgumentException

Method Detail

getReference

public java.lang.String getReference()
                              throws java.rmi.RemoteException,
                                     TransportException

Returns the reference string.

Specified by:

getReference in interface ReferenceEntryInterface

Returns:

String The reference string for this entry.

Throws:

TransportException - If the transport encounters an error getting the reference string.

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

setReference

public void setReference(java.lang.String reference)
                  throws java.rmi.RemoteException,
                         java.lang.IllegalStateException

Sets the reference string.

Specified by:

setReference in interface ReferenceEntryInterface

Parameters:

reference - The reference string for this entry.

Throws:

java.lang.IllegalStateException - If this entry is read only.

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

setReferenceType

public void setReferenceType(java.lang.String referenceType)
                      throws java.lang.IllegalStateException,
                             java.rmi.RemoteException

Sets type of reference.

Specified by:

setReferenceType in interface ReferenceEntryInterface

Parameters:

referenceType - The type of refrence ReferenceEntryInterface.URL_REFERENCE or ReferenceEntryInterface.HTML_REFERENCE

Throws:

java.lang.IllegalStateException - If this entry is read only.

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

getReferenceType

public java.lang.String getReferenceType()
                                  throws java.rmi.RemoteException,
                                         TransportException

Returns the type of reference.

Specified by:

getReferenceType in interface ReferenceEntryInterface

Returns:

String The type of refrence, ReferenceEntryInterface.URL_REFERENCE or ReferenceEntryInterface.HTML_REFERENCE

Throws:

TransportException - If the transport encounters an error getting the reference type.

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

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