jreceiver.common.rpc
Interface Playlists

All Superinterfaces:

RpcBase, ServerTable

public interface Playlists

extends ServerTable

Playlist-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	GET_KEY_COUNT_FOR_MASK
static java.lang.String	GET_KEYS_FOR_MASK
static java.lang.String	HANDLER_NAME
static java.lang.String	REFRESH
static java.lang.String	VALIDATE_FILTER

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	getKeyCountForMask(int pl_mask) Obtain a total count of keys for the specified filter.
java.util.Vector	getKeysForMask(int pl_mask, java.lang.String order_by, int rec_offset, int rec_count) Obtain an ordered range of keys for the specified playlist mask.
void	refresh(java.util.Vector keys) Refresh the tunes in the specified playlists
java.lang.String	validateFilter(java.lang.String raw_filter, java.lang.String order_by) test a playlist filter

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

VALIDATE_FILTER

public static final java.lang.String VALIDATE_FILTER

REFRESH

public static final java.lang.String REFRESH

GET_KEY_COUNT_FOR_MASK

public static final java.lang.String GET_KEY_COUNT_FOR_MASK

GET_KEYS_FOR_MASK

public static final java.lang.String GET_KEYS_FOR_MASK

Method Detail

getKeyCountForMask

public int getKeyCountForMask(int pl_mask)
                       throws RpcException

Obtain a total count of keys for the specified filter.

Recommended when traversing large lists.

getKeysForMask

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

Obtain an ordered range of keys for the specified playlist mask.

Recommended when traversing large lists.

refresh

public void refresh(java.util.Vector keys)
             throws RpcException

Refresh the tunes in the specified playlists

At present, this only supports refreshing stunes in splaylists.

validateFilter

public java.lang.String validateFilter(java.lang.String raw_filter,
                                       java.lang.String order_by)
                                throws RpcException

test a playlist filter

Parameters:

raw_filter -

order_by -

Returns:

null if valid; error string if invalid

Throws:

RpcException -