jreceiver.common.rec.site
Interface Site

All Superinterfaces:

Hashable, Rec

All Known Implementing Classes:

SiteRec

public interface Site

extends Rec

An interface to be implemented by objects representing a 'Site' in JRec.

Corresponds to Sites table in JReceiver database.

Field Summary

static java.lang.String	DEFAULT_HOME_CONTENT_URL
static java.lang.String	HKEY_SITE_CONTENT_URL
static java.lang.String	HKEY_SITE_NAME
static java.lang.String	HKEY_SITE_RPC_URL
static int	SITE_HOME A site_id==1 indicates the home site

Fields inherited from interface jreceiver.common.rec.Rec

HKEY_KEY, NO_LIMIT

Method Summary

java.net.URL	getContentURL() obtain the url for the content engine for the site
java.lang.String	getContentUrlStr() obtain the url (as a String) for the content engine for the site
boolean	getIsLocal() Return true if the site refers to a local file, as indexed in the mfile table.
boolean	getIsRemote() return true if the site is offsite, not indexed in the mfile table.
java.lang.String	getName() obtain the site name (i.e., a local name for someone else's site)
java.net.URL	getRpcURL() obtain the url for the RPC engine for the site
java.lang.String	getRpcUrlStr() obtain the url (as a String) for the RPC engine for the site
int	getSiteId() obtain the site id
void	setContentURL(java.net.URL content_url) assign the url for the content engine for the site
void	setContentUrlStr(java.lang.String url) assign the url (as a String) for the content engine for the site
void	setName(java.lang.String name) assign the site name (i.e., a local name for someone else's site)
void	setRpcURL(java.net.URL rpc_url) assign the url for the RPC engine for the site
void	setRpcUrlStr(java.lang.String url) assign the url (as a String) for the RPC engine for the site
void	setSiteId(int site_id) assign the site id

Methods inherited from interface jreceiver.common.rec.Rec

getKey, setKey

Methods inherited from interface jreceiver.common.rec.Hashable

toHash, toString

Field Detail

SITE_HOME

public static final int SITE_HOME

A site_id==1 indicates the home site

DEFAULT_HOME_CONTENT_URL

public static final java.lang.String DEFAULT_HOME_CONTENT_URL

HKEY_SITE_NAME

public static final java.lang.String HKEY_SITE_NAME

HKEY_SITE_RPC_URL

public static final java.lang.String HKEY_SITE_RPC_URL

HKEY_SITE_CONTENT_URL

public static final java.lang.String HKEY_SITE_CONTENT_URL

Method Detail

getSiteId

public int getSiteId()

obtain the site id

setSiteId

public void setSiteId(int site_id)

assign the site id

getName

public java.lang.String getName()

obtain the site name (i.e., a local name for someone else's site)

setName

public void setName(java.lang.String name)

assign the site name (i.e., a local name for someone else's site)

getRpcURL

public java.net.URL getRpcURL()

obtain the url for the RPC engine for the site

setRpcURL

public void setRpcURL(java.net.URL rpc_url)

assign the url for the RPC engine for the site

getContentURL

public java.net.URL getContentURL()

obtain the url for the content engine for the site

setContentURL

public void setContentURL(java.net.URL content_url)

assign the url for the content engine for the site

getRpcUrlStr

public java.lang.String getRpcUrlStr()

obtain the url (as a String) for the RPC engine for the site

setRpcUrlStr

public void setRpcUrlStr(java.lang.String url)
                  throws java.net.MalformedURLException

assign the url (as a String) for the RPC engine for the site

getContentUrlStr

public java.lang.String getContentUrlStr()

obtain the url (as a String) for the content engine for the site

setContentUrlStr

public void setContentUrlStr(java.lang.String url)
                      throws java.net.MalformedURLException

assign the url (as a String) for the content engine for the site

getIsRemote

public boolean getIsRemote()

return true if the site is offsite, not indexed in the mfile table.

getIsLocal

public boolean getIsLocal()

Return true if the site refers to a local file, as indexed in the mfile table.