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

com.sas.services.publish
Interface ReferenceEntryInterface

All Superinterfaces:

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

All Known Implementing Classes:

ReferenceEntry

public interface ReferenceEntryInterface
extends EntryInterface, java.rmi.Remote

The ReferenceEntryInterface provides a mechanism for setting and getting the attributes of a reference entry. A reference entry simply identifies (references) some data or file (such as a web page) that is external to the package.

Since:

1.0

Field Summary

static java.lang.String	HTML_REFERENCE
static java.lang.String	URL_REFERENCE

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 the type of reference string.

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

getDescription, getNameValuePairs, getURL, isReadOnly, setDescription, setNameValuePairs

Field Detail

HTML_REFERENCE

static final java.lang.String HTML_REFERENCE

See Also:

Constant Field Values

URL_REFERENCE

static final java.lang.String URL_REFERENCE

See Also:

Constant Field Values

Method Detail

getReference

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

Returns the reference string.

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.

java.lang.IllegalStateException - If the package containing this entry is already closed.

setReference

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

Sets the reference string.

Parameters:

reference - The reference string for this entry.

Throws:

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

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

getReferenceType

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

Returns the type of reference.

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.

java.lang.IllegalStateException - If the package containing this entry has already been closed.

setReferenceType

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

Sets the type of reference string.

Parameters:

referenceType - The reference type. Valid reference types include ReferenceEntryInterface.URL_REFERENCE or ReferenceEntryInterface.HTML_REFERENCE

Throws:

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

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

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