jreceiver.common.rec.site
Class FolderRec

java.lang.Object
  |
  +--jreceiver.common.rec.BaseRec
        |
        +--jreceiver.common.rec.site.FolderRec
All Implemented Interfaces:
Folder, Hashable, Rec, Selectable

public class FolderRec
extends BaseRec
implements Folder, Selectable

Bean to represent a single folder record

Version:
$Revision: 1.2 $ $Date: 2002/12/29 00:44:08 $
Author:
Reed Esau

Field Summary
protected  java.io.File folder_file
           
protected  int folder_id
           
protected  java.lang.String folder_name
           
protected  boolean is_checked
          is the item selected in the form?
protected  int parent_id
           
protected  java.lang.String parent_name
           
 
Fields inherited from interface jreceiver.common.rec.site.Folder
GET_CHILD_IDS_NO_RECURSE, GET_CHILD_IDS_RECURSE, HKEY_FOLDER_FILE, HKEY_FOLDER_ID, HKEY_FOLDER_NAME, HKEY_PARENT_ID, HKEY_PARENT_NAME, POPULATE_FOLDER_FILE
 
Fields inherited from interface jreceiver.common.rec.Rec
HKEY_KEY, NO_LIMIT
 
Fields inherited from interface jreceiver.common.rec.Selectable
HKEY_CHECKED
 
Constructor Summary
FolderRec()
          ctor
FolderRec(java.util.Hashtable hash)
          ctor - construct from a hashtable, usually retrieved via XML-RPC
FolderRec(int folder_id, java.lang.String folder_name, int parent_id)
          ctor
FolderRec(int folder_id, java.lang.String folder_name, int parent_id, java.lang.String parent_name, java.io.File folder_file)
          ctor
 
Method Summary
 boolean getChecked()
          get the current select state
 java.io.File getFolderFile()
           
 int getFolderId()
           
 java.lang.String getFolderName()
           
 java.lang.Object getKey()
          return the Integer object that serves as this Rec's key.
 int getParentId()
           
 java.lang.String getParentName()
           
static java.util.Vector reconstitute(java.util.Vector vector)
          Reconstitute each FolderRec object that appears as a hash in the list.
 void setChecked(boolean is_checked)
          set the select state
 void setFolderFile(java.io.File folder_file)
           
 void setFolderId(int folder_id)
           
 void setFolderName(java.lang.String folder_name)
           
 void setKey(java.lang.Object new_key)
          assign the Number-derived, Key-derived or String that serves as this Rec's key.
 void setParentId(int parent_id)
           
 void setParentName(java.lang.String parent_name)
           
 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

folder_name

protected java.lang.String folder_name

folder_id

protected int folder_id

parent_name

protected java.lang.String parent_name

parent_id

protected int parent_id

folder_file

protected java.io.File folder_file

is_checked

protected boolean is_checked
is the item selected in the form?
Constructor Detail

FolderRec

public FolderRec()
ctor

FolderRec

public FolderRec(int folder_id,
                 java.lang.String folder_name,
                 int parent_id)
ctor

FolderRec

public FolderRec(int folder_id,
                 java.lang.String folder_name,
                 int parent_id,
                 java.lang.String parent_name,
                 java.io.File folder_file)
ctor

FolderRec

public FolderRec(java.util.Hashtable hash)
ctor - construct from a hashtable, usually retrieved via XML-RPC
Parameters:
hash -  
Method Detail

getKey

public java.lang.Object getKey()
return the Integer 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

getFolderName

public java.lang.String getFolderName()
Specified by:
getFolderName in interface Folder

setFolderName

public void setFolderName(java.lang.String folder_name)
Specified by:
setFolderName in interface Folder

getFolderId

public int getFolderId()
Specified by:
getFolderId in interface Folder

setFolderId

public void setFolderId(int folder_id)
Specified by:
setFolderId in interface Folder

getParentName

public java.lang.String getParentName()
Specified by:
getParentName in interface Folder

setParentName

public void setParentName(java.lang.String parent_name)
Specified by:
setParentName in interface Folder

getParentId

public int getParentId()
Specified by:
getParentId in interface Folder

setParentId

public void setParentId(int parent_id)
Specified by:
setParentId in interface Folder

getFolderFile

public java.io.File getFolderFile()
Specified by:
getFolderFile in interface Folder

setFolderFile

public void setFolderFile(java.io.File folder_file)
Specified by:
setFolderFile in interface Folder

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 -  

toHash

public java.util.Hashtable toHash()
Store the object as a hash suitable for transport over an XML-RPC connection or similar.

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

Specified by:
toHash in interface Hashable
Returns:
 

toString

public java.lang.String toString()
Description copied from interface: Hashable
Returns a string representation of the object.
Specified by:
toString in interface Hashable
Overrides:
toString in class java.lang.Object

reconstitute

public static java.util.Vector reconstitute(java.util.Vector vector)
Reconstitute each FolderRec object that appears as a hash in the list.


Copyright © 2001-2002 Reed Esau, All Rights Reserved.