psdi.server

Interface MaxVarServiceRemote

All Superinterfaces:

java.rmi.Remote, ServiceRemote

All Known Implementing Classes:

MaxVarService

public interface MaxVarServiceRemote
extends java.rmi.Remote, ServiceRemote

An Interface for remote access to the MaxVarService. Any name value pairs can be stored here and passed between Services.

Version:

%I%, %G%

Author:

John Langley

See Also:

Hashtable, Service, psdi.server.SrvContext

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getBoolean(java.lang.String key, java.lang.String orgSite) Return the value for the MaxVar as a boolean, returning the default if the MaxVar is not defined.
double	getDouble(java.lang.String key, java.lang.String orgSite) Return the value for the MaxVar as a double, returning the default if the MaxVar is not defined.
float	getFloat(java.lang.String key, java.lang.String orgSite) Return the value for the MaxVar as a float, returning the default if the MaxVar is not defined.
int	getInt(java.lang.String key, java.lang.String orgSite) Return the value for the MaxVar as an integer, returning the default if the MaxVar is not defined.
long	getLong(java.lang.String key, java.lang.String orgSite) Return the value for the MaxVar as a long, returning the default if the MaxVar is not defined.
java.lang.String	getMaxVarType(java.lang.String key) Returns the maxvartype for the varname
java.lang.String	getString(java.lang.String key, java.lang.String orgSite) Return the value for the MaxVar as a string, returning the default if the MaxVar is not defined.
java.lang.String	getString(java.lang.String key, java.lang.String org, java.lang.String Site) Returns the value for maxvar for given org and site
java.lang.String[]	getStringList(java.lang.String key, java.lang.String orgSite) Return the specified variable as a String[].
boolean	isNull(java.lang.String key, java.lang.String orgSite) Return true if the row exists in maxvars but the varvalue is null.
java.lang.Object	put(java.lang.String key, java.lang.String orgSiteId, java.lang.Object value)
java.lang.Object	remove(java.lang.String key, java.lang.String orgSiteId)

Methods inherited from interface psdi.server.ServiceRemote

getName, getURL, isAppService, isSingletonService, restart

Method Detail

getStringList

java.lang.String[] getStringList(java.lang.String key,
                               java.lang.String orgSite)
                                 throws MXException,
                                        java.rmi.RemoteException

Return the specified variable as a String[]. In the DB this is stored as a ',' separated list of values.

Parameters:

key - The name of the MaxVar

orgSite -

Returns:

The values for the MaxVar

Throws:

MXException

java.rmi.RemoteException

getString

java.lang.String getString(java.lang.String key,
                         java.lang.String orgSite)
                           throws java.rmi.RemoteException,
                                  MXException

Return the value for the MaxVar as a string, returning the default if the MaxVar is not defined. The default value is not set as the MaxVar's value.

Parameters:

key - The name of the MaxVar

orgSite -

Returns:

The value for the MaxVar

Throws:

java.rmi.RemoteException

MXException

getInt

int getInt(java.lang.String key,
         java.lang.String orgSite)
           throws java.rmi.RemoteException,
                  MXException

Return the value for the MaxVar as an integer, returning the default if the MaxVar is not defined.

Parameters:

key - The name of the MaxVar

orgSite -

Returns:

The value for the MaxVar

Throws:

java.rmi.RemoteException

MXException

getBoolean

boolean getBoolean(java.lang.String key,
                 java.lang.String orgSite)
                   throws java.rmi.RemoteException,
                          MXException

Return the value for the MaxVar as a boolean, returning the default if the MaxVar is not defined.

Parameters:

key - The name of the MaxVar

orgSite -

Returns:

The value for the MaxVar

Throws:

java.rmi.RemoteException

MXException

isNull

boolean isNull(java.lang.String key,
             java.lang.String orgSite)
               throws java.rmi.RemoteException,
                      MXException

Return true if the row exists in maxvars but the varvalue is null.

Parameters:

key - The name of the MaxVar

orgSite -

Returns:

boolean

Throws:

java.rmi.RemoteException

MXException

getDouble

double getDouble(java.lang.String key,
               java.lang.String orgSite)
                 throws java.rmi.RemoteException,
                        MXException

Return the value for the MaxVar as a double, returning the default if the MaxVar is not defined.

Parameters:

key - The name of the MaxVar

orgSite -

Returns:

The value for the MaxVar

Throws:

java.rmi.RemoteException

MXException

getFloat

float getFloat(java.lang.String key,
             java.lang.String orgSite)
               throws java.rmi.RemoteException,
                      MXException

Return the value for the MaxVar as a float, returning the default if the MaxVar is not defined.

Parameters:

key - The name of the MaxVar

orgSite -

Returns:

The value for the MaxVar

Throws:

java.rmi.RemoteException

MXException

getLong

long getLong(java.lang.String key,
           java.lang.String orgSite)
             throws java.rmi.RemoteException,
                    MXException

Return the value for the MaxVar as a long, returning the default if the MaxVar is not defined.

Parameters:

key - The name of the MaxVar

orgSite -

Returns:

The value for the MaxVar

Throws:

java.rmi.RemoteException

MXException

put

java.lang.Object put(java.lang.String key,
                   java.lang.String orgSiteId,
                   java.lang.Object value)
                     throws java.rmi.RemoteException,
                            MXException

Throws:

java.rmi.RemoteException

MXException

See Also:

MaxVarService.put(java.lang.String, java.lang.String, java.lang.Object)

remove

java.lang.Object remove(java.lang.String key,
                      java.lang.String orgSiteId)
                        throws MXException,
                               java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxVarService.remove(java.lang.String, java.lang.String)

getMaxVarType

java.lang.String getMaxVarType(java.lang.String key)
                               throws java.rmi.RemoteException,
                                      MXException

Returns the maxvartype for the varname

Parameters:

key -

Returns:

maxvartype

Throws:

MXException,RemoteException

java.rmi.RemoteException

MXException

getString

java.lang.String getString(java.lang.String key,
                         java.lang.String org,
                         java.lang.String Site)
                           throws java.rmi.RemoteException,
                                  MXException

Returns the value for maxvar for given org and site

Parameters:

key -

org -

site -

Returns:

var value

Throws:

MXException,RemoteException

java.rmi.RemoteException

MXException