jreceiver.common.rpc
Interface Folders

All Superinterfaces:

RpcBase, ServerTable

public interface Folders

extends ServerTable

Folder-related queries and updates for a (possibly-remote) JRec server

Version:

$Revision: 1.3 $ $Date: 2002/07/31 11:29:41 $

Author:

Reed Esau

Field Summary

static java.lang.String	FIND_PARENT
static java.lang.String	GET_CHILD_KEYS
static java.lang.String	GET_ROOT_KEYS
static java.lang.String	HANDLER_NAME

Fields inherited from interface jreceiver.common.rpc.ServerTable

DELETE_RECS, GET_KEY_COUNT, GET_KEYS, GET_REC, GET_RECS, STORE_REC, STORE_RECS

Fields inherited from interface jreceiver.common.rpc.RpcBase

DETECT

Method Summary

int	findParent(int folder_id, java.util.Set parents) Attempt to determine whether or not folder_id has a parent amongst the set of parents.
java.util.Vector	getChildKeys(int parent_id, java.lang.String order_by, boolean recurse, int rec_offset, int rec_count) Obtain a list of folder_ids which represent the children of the folder associated with parent_id.
java.util.Vector	getRootKeys(java.lang.String order_by, int rec_offset, int rec_count) Obtain a list of folder_ids which represent the root folders

Methods inherited from interface jreceiver.common.rpc.ServerTable

deleteRecs, getKeyCount, getKeys, getRec, getRec, getRecs, getRecs, storeRec, storeRecs

Methods inherited from interface jreceiver.common.rpc.RpcBase

detect

Field Detail

HANDLER_NAME

public static final java.lang.String HANDLER_NAME

GET_CHILD_KEYS

public static final java.lang.String GET_CHILD_KEYS

GET_ROOT_KEYS

public static final java.lang.String GET_ROOT_KEYS

FIND_PARENT

public static final java.lang.String FIND_PARENT

Method Detail

getChildKeys

public java.util.Vector getChildKeys(int parent_id,
                                     java.lang.String order_by,
                                     boolean recurse,
                                     int rec_offset,
                                     int rec_count)
                              throws RpcException

Obtain a list of folder_ids which represent the children of the folder associated with parent_id.

getRootKeys

public java.util.Vector getRootKeys(java.lang.String order_by,
                                    int rec_offset,
                                    int rec_count)
                             throws RpcException

Obtain a list of folder_ids which represent the root folders

findParent

public int findParent(int folder_id,
                      java.util.Set parents)
               throws RpcException

Attempt to determine whether or not folder_id has a parent amongst the set of parents.

Note that 0 is not considered a valid folder_id and will be ignored if in the list of parents.

Returns:

the folder_id of the parent, if found; otherwise 0.