jreceiver.common.rec.site
Class RootRec

java.lang.Object
  |
  +--jreceiver.common.rec.BaseRec
        |
        +--jreceiver.common.rec.site.RootRec

All Implemented Interfaces:

Hashable, Rec, Root, Selectable

public class RootRec

extends BaseRec

implements Root, Selectable

Bean to represent a single root folder record

Version:

$Revision: 1.2 $ $Date: 2002/12/29 00:44:08 $

Author:

Reed Esau

Field Summary

protected int	folder_id The key in the folders table which represents the root.
protected boolean	is_checked is the item selected in the form?
protected RootKey	key

Fields inherited from interface jreceiver.common.rec.site.Root

HKEY_FOLDER_ID

Fields inherited from interface jreceiver.common.rec.Rec

HKEY_KEY, NO_LIMIT

Fields inherited from interface jreceiver.common.rec.Selectable

HKEY_CHECKED

Constructor Summary

RootRec()
ctor - default

RootRec(java.util.Hashtable hash)
ctor - construct from a hashtable, usually retrieved via XML-RPC

RootRec(RootKey key)
ctor - shallow

RootRec(RootKey key, int folder_id)
ctor - deep

Method Summary

boolean	getChecked() get the current select state
int	getFolderId()
java.lang.Object	getKey() return the Integer or Key object that serves as this Rec's key.
void	setChecked(boolean is_checked) set the select state
void	setFolderId(int folder_id)
void	setKey(java.lang.Object new_key) assign the Number-derived, Key-derived or String that serves as this Rec's key.
java.util.Hashtable	toHash() Store the object as a hash suitable for transport over an XML-RPC connection or similar.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class jreceiver.common.rec.BaseRec

dissolve, dissolveMap, find, find, find, find

Methods inherited from class java.lang.Object

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

Field Detail

key

protected RootKey key

is_checked

protected boolean is_checked

is the item selected in the form?

folder_id

protected int folder_id

The key in the folders table which represents the root. Note that a value of 0 indicates the root doesn't have a folder_id assigned and hasn't been scanned yet.

Constructor Detail

RootRec

public RootRec()

ctor - default

RootRec

public RootRec(RootKey key)

ctor - shallow

RootRec

public RootRec(RootKey key,
               int folder_id)

ctor - deep

RootRec

public RootRec(java.util.Hashtable hash)

ctor - construct from a hashtable, usually retrieved via XML-RPC

Method Detail

getKey

public java.lang.Object getKey()

return the Integer or Key object that serves as this Rec's key.

Specified by:

getKey in interface Rec

setKey

public void setKey(java.lang.Object new_key)

assign the Number-derived, Key-derived or String that serves as this Rec's key.

Specified by:

setKey in interface Rec

getChecked

public boolean getChecked()

Description copied from interface: Selectable

get the current select state

Specified by:

getChecked in interface Selectable

Following copied from interface: jreceiver.common.rec.Selectable

Returns:

boolean true if the item has been selected by the user; false otherwise

setChecked

public void setChecked(boolean is_checked)

Description copied from interface: Selectable

set the select state

Specified by:

setChecked in interface Selectable

Following copied from interface: jreceiver.common.rec.Selectable

Parameters:

is_checked -

getFolderId

public int getFolderId()

Specified by:

getFolderId in interface Root

setFolderId

public void setFolderId(int folder_id)

Specified by:

setFolderId in interface Root

toString

public java.lang.String toString()

Returns a string representation of the object.

Specified by:

toString in interface Hashable

Overrides:

toString in class java.lang.Object

toHash

public java.util.Hashtable toHash()

Store the object as a hash suitable for transport over an XML-RPC connection or similar.

Use RootRec(Hashtable) to transform the data back into an object of this type.

Specified by:

toHash in interface Hashable

Returns: