org.paneris.melati.site.model
Interface Templated

All Known Implementing Classes:

Page

public interface Templated

An object with a template field.

Author:

timp@paneris.org

Method Summary

java.lang.Integer	getTemplate_unsafe() Retrieves the Template value, without locking, for this Page Persistent.
Template	getTemplate() Retrieves the Template object reffered to.
org.melati.poem.Field	getTemplateField() Retrieves the Template value as a Field from this Page Persistent.
java.lang.Integer	getTemplateTroid() Retrieves the Table Row Object ID.
void	setTemplate_unsafe(java.lang.Integer cooked) Sets the Template value directly, without checking, for this Page Persistent.
void	setTemplate(Template cooked) Set the Template.
void	setTemplateTroid(java.lang.Integer raw) Sets the Table Row Object ID.

Method Detail

getTemplate_unsafe

java.lang.Integer getTemplate_unsafe()

Retrieves the Template value, without locking, for this Page Persistent.

Returns:

the Integer template

setTemplate_unsafe

void setTemplate_unsafe(java.lang.Integer cooked)

Sets the Template value directly, without checking, for this Page Persistent.

Parameters:

cooked - the pre-validated value to set

getTemplateTroid

java.lang.Integer getTemplateTroid()
                                   throws org.melati.poem.AccessPoemException

Retrieves the Table Row Object ID.

Returns:

the TROID as an Integer

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer read access rights

setTemplateTroid

void setTemplateTroid(java.lang.Integer raw)
                      throws org.melati.poem.AccessPoemException

Sets the Table Row Object ID.

Parameters:

raw - a Table Row Object Id

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

getTemplate

Template getTemplate()
                     throws org.melati.poem.AccessPoemException,
                            org.melati.poem.NoSuchRowPoemException

Retrieves the Template object reffered to.

Returns:

the Template as a Template

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer read access rights

org.melati.poem.NoSuchRowPoemException - if the has yet to be allocated a TROID

setTemplate

void setTemplate(Template cooked)
                 throws org.melati.poem.AccessPoemException

Set the Template.

Parameters:

cooked - a validated Template

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights

getTemplateField

org.melati.poem.Field getTemplateField()
                                       throws org.melati.poem.AccessPoemException

Retrieves the Template value as a Field from this Page Persistent.

Returns:

the Integer template

Throws:

org.melati.poem.AccessPoemException - if the current AccessToken does not confer write access rights