net.agmodel.resData
Interface ResourceUser

All Superinterfaces:

Remote, ServerRMI

All Known Subinterfaces:

ResourceEditor, ResourceSuper, ResourceTranslator

public interface ResourceUser

extends ServerRMI

Title: Description: Copyright: Copyright (c) 2002 Company:

Field Summary

static String	RMIHOSTPARAM
static String	RMINAME

Fields inherited from interface net.agmodel.genericBroker.ServerRMI

EXISTINGUSER, NEWUSER, SUPERUSER

Method Summary

String[]	getAllItemDescription(String sessionID, String fileSetID, String[] itemKeys) Gets the item_description for the set of item_ids.
String	getItemDescription(String sessionID, String fileSetID, String itemKey) Gets the item_description for the item_id.
String	getLanguageName(String sessionID, String readerID, String languageID) Gets the language name of a languageID.
ResItem	getResItem(String sessionID, String languageID, String fileSet, String itemKey) Get a single resource item.
ResItem[]	getResItems(String sessionID, String languageID, String fileSet, String[] itemKeys) Get a set of resource items.
UserFileSet	getUserFileSet(String sessionID, String languageID, String fileSetID) Gets the UserFileSet object for a perticular language and fileSetID for the ResourceUser.
String[]	listFileSet(String sessionID) Gets the details for all fileSet of a perticular language from the ResourceServer.
String[]	listLanguageID(String sessionID) Gets the 2 character IDs of all the languages supported by the ResourceServer.
String[]	listLanguages(String sessionID, String readerID) Gets the names of all the languages supported by the ResourceServer.

Methods inherited from interface net.agmodel.genericBroker.ServerRMI

disconnect, getConnection, getConnection

Field Detail

RMINAME

public static final String RMINAME

See Also:

Constant Field Values

RMIHOSTPARAM

public static final String RMIHOSTPARAM

See Also:

Constant Field Values

Method Detail

getResItem

public ResItem getResItem(String sessionID,
                          String languageID,
                          String fileSet,
                          String itemKey)
                   throws RemoteException,
                          GeneralException

Get a single resource item.

Parameters:

sessionID - the identifier provided by getConnection

fileSet - the name of the set of files of interest (eg UtilityResource)

itemKey - the key identifying the required resource item.

Returns:

the item of interest, in the user's preferred language

Throws:

RemoteException.

RemoteException

GeneralException

getResItems

public ResItem[] getResItems(String sessionID,
                             String languageID,
                             String fileSet,
                             String[] itemKeys)
                      throws RemoteException,
                             GeneralException

Get a set of resource items.

Parameters:

sessionID - the identifier provided by getConnection

fileSet - the name of the set of files of interest (eg UtilityResource)

itemKeys - an array of keys identifying the required resource items.

Returns:

the items of interest, in the user's preferred language, in the same order as the keys

Throws:

RemoteException.

RemoteException

GeneralException

listFileSet

public String[] listFileSet(String sessionID)
                     throws RemoteException,
                            GeneralException

Gets the details for all fileSet of a perticular language from the ResourceServer.

Parameters:

sessionID - the identifier provided by getConnection

Throws:

RemoteException.

RemoteException

GeneralException

getLanguageName

public String getLanguageName(String sessionID,
                              String readerID,
                              String languageID)
                       throws RemoteException,
                              GeneralException

Gets the language name of a languageID.

Parameters:

sessionID - the identifier provided by getConnection

languageID - a standard ISO two letter String identifying the language (eg "en") from which fileSet detail is needed.

Throws:

RemoteException.

RemoteException

GeneralException

getUserFileSet

public UserFileSet getUserFileSet(String sessionID,
                                  String languageID,
                                  String fileSetID)
                           throws RemoteException,
                                  GeneralException

Gets the UserFileSet object for a perticular language and fileSetID for the ResourceUser.

Parameters:

sessionID - the identifier provided by getConnection

languageID - a standard ISO two letter String identifying the language (eg "en") from which fileSet detail is needed.

fileSetID - the name of the file(resource) of interest (eg Utility)

Throws:

RemoteException.

RemoteException

GeneralException

getAllItemDescription

public String[] getAllItemDescription(String sessionID,
                                      String fileSetID,
                                      String[] itemKeys)
                               throws RemoteException,
                                      GeneralException

Gets the item_description for the set of item_ids.

Parameters:

sessionID - the identifier provided by getConnection

fileSetID - the name of the ResFileSet(fileSetID) of interest (eg Utility)

itemKeys - set of item_ids for which item_description are needed

Throws:

RemoteException.

RemoteException

GeneralException

getItemDescription

public String getItemDescription(String sessionID,
                                 String fileSetID,
                                 String itemKey)
                          throws RemoteException,
                                 GeneralException

Gets the item_description for the item_id.

Parameters:

sessionID - the identifier provided by getConnection

fileSetID - the name of the ResFileSet(fileSetID) of interest (eg Utility)

itemKey - the item_id for which item_description is needed

Throws:

RemoteException.

RemoteException

GeneralException

listLanguages

public String[] listLanguages(String sessionID,
                              String readerID)
                       throws RemoteException,
                              GeneralException

Gets the names of all the languages supported by the ResourceServer.

Parameters:

sessionID - the identifier for the client provided by getConnection

Throws:

RemoteException.

RemoteException

GeneralException

listLanguageID

public String[] listLanguageID(String sessionID)
                        throws RemoteException,
                               GeneralException

Gets the 2 character IDs of all the languages supported by the ResourceServer.

Parameters:

sessionID - the identifier for the client provided by getConnection

Throws:

RemoteException.

RemoteException

GeneralException