Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> RuntimeCollective >> sitemap >> [ bean overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.RuntimeCollective.sitemap.bean
Class SiteLocationLink  

java.lang.Object
  com.RuntimeCollective.content.bean.SimpleContent
      com.RuntimeCollective.content.bean.Link
          com.RuntimeCollective.sitemap.bean.SiteLocationLink

All Implemented Interfaces:

com.RuntimeCollective.content.bean.Content, com.RuntimeCollective.webapps.bean.Duplicable, com.RuntimeCollective.webapps.bean.EntityBean, java.io.Serializable

---

public class SiteLocationLink

extends com.RuntimeCollective.content.bean.Link

The SiteLocationLink class implements the abstract Link class, by linking to a SiteLocation. NB: Saving a SLL doesn't save its SiteLocation, as that could provoke some infinite loop. So take care of saving the destination first.

Version:

$Id: SiteLocationLink.java,v 1.26 2003/09/30 15:12:59 joe Exp $

---

Field Summary
protected static java.lang.String	closeTag
static java.lang.String	DATABASE_TABLE           The name of the database table for this bean type.
static java.lang.String	ID_PARAM
static java.lang.String	NOTHING
protected static java.lang.String	PDFDOCUMENT
static java.lang.String	PREVIEW_PAGE_DEFAULT
static java.lang.String	PREVIEW_PAGE_PARAM
protected  int	SiteLocationId           Does this SiteLocationLink link to a SiteLocation, and then which one ?
static java.lang.String	VIEW_PAGE_DEFAULT
static java.lang.String	VIEW_PAGE_PARAM

 

Fields inherited from class com.RuntimeCollective.content.bean.Link

AHREF, CLOSE_TAG, END_QUOTE, END_TAG, ExplanatoryText, FOLLOW_LINK, HTTP, IsTrackable, LinkText, NEW_TARGET, NumberOfHits, OpenInNewWindow, PAGE_ROOT

 

Fields inherited from class com.RuntimeCollective.content.bean.SimpleContent

Author_id, CreationDate, id, LastModifiedDate, LastModifierUser_id

 

Fields inherited from interface com.RuntimeCollective.webapps.bean.EntityBean

INTERFACE_BEAN, NULL_ID

 

Constructor Summary

SiteLocationLink()           Construct a new blank SiteLocationLink, giving it a new unique ID.

SiteLocationLink(int id)           Get a SiteLocationLink from the database, given an id.

 

Method Summary
void	delete()           Delete this SiteLocationLink from the database.
java.lang.String	getLinkCloseTag()           Close the link and conditionally add the file type, if this is a link to the file type template (in this case it is called the pdf template but is used for other file types aswell) and whether or not it opens in a new window info
java.lang.String	getLinkText()           Get the LinkText: for a SiteLocationLink, this uses the SiteLocation's Name or SectionName.
java.net.URL	getLinkURL()           Get the LinkURL: a link to viewPage (if the link isDisplayable) or previewPage (otherwise).
boolean	getOpenInNewWindow()           Get the OpenInNewWindow: redefine to take into account the template of the SiteLocation
SiteLocation	getSiteLocation()           Get the SiteLocation, the trunk version of it if it exists.
SiteLocation	getSiteLocation(java.lang.String useVersion)           Get the SiteLocation, possibly checking a particular version.
int	getSiteLocationId()           Get the SiteLocation's Id.
boolean	isDisplayable()           Is this link displayable, ie is it valid (using the Live version of the SiteLocation if it exists).
boolean	isDisplayable(boolean useLive)           Is this link displayable, ie is it valid (using or not the Live version of the SiteLocation).
void	save()           Save this SiteLocationLink to the database.
void	setSiteLocation(SiteLocation siteLocation)           Set the SiteLocation.

 

Methods inherited from class com.RuntimeCollective.content.bean.Link

addHit, getDescription, getExplanatoryText, getIsTrackable, getLinkOpenTag, getNumberOfHits, getTitle, isTrackable, setExplanatoryText, setIsTrackable, setLinkText, setNumberOfHits, setOpenInNewWindow, viewFormat

 

Methods inherited from class com.RuntimeCollective.content.bean.SimpleContent

customiseDuplicate, getAuthor, getCreationDate, getId, getLastModifiedDate, getLastModifierUser, makeDuplicate, makeDuplicate, setAuthor, setCreationDate, setDescription, setId, setLastModifiedDate, setLastModifierUser, setTitle

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

DATABASE_TABLE

public static final java.lang.String DATABASE_TABLE

The name of the database table for this bean type.

See Also:

Constant Field Values

---

PREVIEW_PAGE_PARAM

public static java.lang.String PREVIEW_PAGE_PARAM

---

VIEW_PAGE_PARAM

public static java.lang.String VIEW_PAGE_PARAM

---

PREVIEW_PAGE_DEFAULT

public static java.lang.String PREVIEW_PAGE_DEFAULT

---

VIEW_PAGE_DEFAULT

public static java.lang.String VIEW_PAGE_DEFAULT

---

ID_PARAM

public static java.lang.String ID_PARAM

---

NOTHING

public static java.lang.String NOTHING

---

SiteLocationId

protected int SiteLocationId

Does this SiteLocationLink link to a SiteLocation, and then which one ?

---

PDFDOCUMENT

protected static java.lang.String PDFDOCUMENT

---

closeTag

protected static java.lang.String closeTag

Constructor Detail

SiteLocationLink

public SiteLocationLink()
                 throws java.sql.SQLException

Construct a new blank SiteLocationLink, giving it a new unique ID.

---

SiteLocationLink

public SiteLocationLink(int id)
                 throws java.sql.SQLException

Get a SiteLocationLink from the database, given an id.

Method Detail

save

public void save()
          throws java.sql.SQLException

Save this SiteLocationLink to the database.

---

delete

public void delete()
            throws java.sql.SQLException

Delete this SiteLocationLink from the database.

---

isDisplayable

public boolean isDisplayable()

Is this link displayable, ie is it valid (using the Live version of the SiteLocation if it exists).

---

isDisplayable

public boolean isDisplayable(boolean useLive)

Is this link displayable, ie is it valid (using or not the Live version of the SiteLocation).

If useLive is false, use the SiteLocation this object really refers to.
If useLive is true, use the Live version of the SiteLocation (if it exists, otherwise, the SiteLocation itself).

---

getLinkURL

public java.net.URL getLinkURL()

Get the LinkURL: a link to viewPage (if the link isDisplayable) or previewPage (otherwise). For plain users, you should check if the link is displayable before calling this.

---

getLinkText

public java.lang.String getLinkText()

Get the LinkText: for a SiteLocationLink, this uses the SiteLocation's Name or SectionName.

---

getOpenInNewWindow

public boolean getOpenInNewWindow()

Get the OpenInNewWindow: redefine to take into account the template of the SiteLocation

---

setSiteLocation

public void setSiteLocation(SiteLocation siteLocation)

Set the SiteLocation.

---

getSiteLocation

public SiteLocation getSiteLocation()

Get the SiteLocation, the trunk version of it if it exists.

---

getSiteLocation

public SiteLocation getSiteLocation(java.lang.String useVersion)

Get the SiteLocation, possibly checking a particular version.

If useVersion is null, return the SiteLocation this object really refers to.
Otherwise, return the specified version of this object, if there is one. If there isn't, then use this version.

---

getSiteLocationId

public int getSiteLocationId()

Get the SiteLocation's Id. This is necessary, for a reason too long to explain.

---

getLinkCloseTag

public java.lang.String getLinkCloseTag()

Close the link and conditionally add the file type, if this is a link to the file type template (in this case it is called the pdf template but is used for other file types aswell) and whether or not it opens in a new window info

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> RuntimeCollective >> sitemap >> [ bean overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---