SiteLocation

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> RuntimeCollective >> sitemap >> [ bean overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.RuntimeCollective.sitemap.bean.SiteLocation

SOURCE |

Download com.RuntimeCollective.sitemap.bean.SiteLocation

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.RuntimeCollective.sitemap.bean
Interface SiteLocation

All Superinterfaces:: com.RuntimeCollective.webapps.bean.EntityBean, com.RuntimeCollective.permission.bean.Permissible, com.RuntimeCollective.webapps.bean.PermissionBean, Publishable, java.io.Serializable

All Known Implementing Classes:: SimpleSiteLocation

public interface SiteLocation
extends Publishable

The interface to implement if you want an object to be a location within your site map.

Version:: $Id: SiteLocation.java,v 1.8 2003/09/30 15:12:59 joe Exp $

Field Summary

static java.lang.String DATABASE_TABLE
          The name of the database table for this bean type.

Fields inherited from interface com.RuntimeCollective.sitemap.bean.Publishable

STATUS_APPROVED, STATUS_ARCHIVED, STATUS_EDITED, STATUS_TO_BE_APPROVED

Fields inherited from interface com.RuntimeCollective.permission.bean.Permissible

EDIT_ACTION, VIEW_ACTION

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

INTERFACE_BEAN, NULL_ID

Method Summary

java.lang.String getBreadcrumb()
          Get the breadcrumb (plain text) to this SiteLocation

java.lang.String getDescription()
          Get the description The description will be extracted from sub-class specific information, for example from the text of the headline.

java.lang.String getLinkOpenTag()
          Get the opening Tag to this SiteLocation, including href and target attributes

java.lang.String getName()
          Get the name

boolean getOfInterest()
          Get whether this SiteLocation is of interest

Template getTheTemplate()
          Get the template

java.lang.String getTitle()
          Get the title The title will be extracted from sub-class specific information, for example from the text of the headline.

java.net.URL getURL()
          Get the whole URL to get to this SiteLocation

java.lang.String getWebURLStub()
          Get the URL stub

boolean isOfInterest()
          Get whether this SiteLocation is of interest.

void setName(java.lang.String name)
          Set the name

void setOfInterest(boolean bool)
          Set whether this SiteLocation is of interest

void setTheTemplate(Template template)
          Set the template used by this SiteLocation

void setWebURLStub(java.lang.String stub)
          Set the URL stub (e.g.

Methods inherited from interface com.RuntimeCollective.sitemap.bean.Publishable

getAlwaysLive, getGoDeadDate, getGoLiveDate, getIsNew, getNeedApproval, getStatus, getStatusLastModifiedDate, isAlwaysLive, isApproved, isArchived, isEdited, isLive, isNew, isToBeApproved, markAsApproved, markAsArchived, markAsEdited, markAsToBeApproved, needsApproval, publish, saveArchivedData, setAlwaysLive, setGoDeadDate, setGoLiveDate, setIsNew, setNeedApproval, setStatus, setStatusLastModifiedDate

Methods inherited from interface com.RuntimeCollective.permission.bean.Permissible

canEdit, canPerformAction, canView, delete, getActionPermissionRule, getActions, getAuthorisationPathForAction, getAuthorisationPathForAction, getId, save, setActionPermissionRule, setId

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

Method Detail

setName

public void setName(java.lang.String name)

Set the name

getName

public java.lang.String getName()

Get the name

setWebURLStub

public void setWebURLStub(java.lang.String stub)

Set the URL stub (e.g. "ecommerce" for the ecommerce node)

getWebURLStub

public java.lang.String getWebURLStub()

Get the URL stub

setTheTemplate

public void setTheTemplate(Template template)

Set the template used by this SiteLocation

getTheTemplate

public Template getTheTemplate()

Get the template

getURL

public java.net.URL getURL()

Get the whole URL to get to this SiteLocation

getLinkOpenTag

public java.lang.String getLinkOpenTag()

Get the opening Tag to this SiteLocation, including href and target attributes

getBreadcrumb

public java.lang.String getBreadcrumb()

Get the breadcrumb (plain text) to this SiteLocation

getTitle

public java.lang.String getTitle()

Get the title The title will be extracted from sub-class specific information, for example from the text of the headline. The title will be in plain text format. This is a commodity method useful when displaying lists of site locations.

getDescription

public java.lang.String getDescription()

Get the description The description will be extracted from sub-class specific information, for example from the text of the headline. The title will be in plain text format. This is a commodity method useful when displaying lists of site locations.

setOfInterest

public void setOfInterest(boolean bool)

Set whether this SiteLocation is of interest

getOfInterest

public boolean getOfInterest()

Get whether this SiteLocation is of interest

isOfInterest

public boolean isOfInterest()

Get whether this SiteLocation is of interest. Redirects to getOfInterest(boolean).