Thor.API.Base

Class tcBaseUtilityClient

java.lang.Object

Thor.API.Base.tcBaseUtilityClient

All Implemented Interfaces:

java.io.Serializable, tcUtilityOperationsIntf

public abstract class tcBaseUtilityClient
extends java.lang.Object
implements tcUtilityOperationsIntf, java.io.Serializable

Base utility client-side class. All client-side Utility/API classes must extend from this class. It provides all the base functionality necessary for a client-side object.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	close() This method will try to remove the bean instance on the server side so that the bean can return to the ready pool.
void	close(boolean calledFromFinalize) This method will notify the object manager that it is finished with the server-side object, and can remove it from the orb.
java.lang.String	getName() Returns the descriptive name.
void	setCountry(java.lang.String psCountry) Sets the country.
void	setLanguage(java.lang.String psLanguage) Sets the language.
void	setVariant(java.lang.String psVariant) Sets the variant.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public java.lang.String getName()
                         throws tcAPIException

Returns the descriptive name.

Specified by:

getName in interface tcUtilityOperationsIntf

Returns:

The name.

Throws:

tcAPIException - If the server-side class cannot be retrieved

setLanguage

public void setLanguage(java.lang.String psLanguage)

Sets the language. Used in defining the locality that this utility class represents. Only to be called by tcUtilityIntf.

Specified by:

setLanguage in interface tcUtilityOperationsIntf

Parameters:

psLanguage - The language.

setCountry

public void setCountry(java.lang.String psCountry)

Sets the country. Used in defining the locality that this utility class represents. Only to be called by tcUtilityIntf.

Specified by:

setCountry in interface tcUtilityOperationsIntf

Parameters:

psCountry - The country.

setVariant

public void setVariant(java.lang.String psVariant)

Sets the variant. Used in defining the locality that this utility class represents. Only to be called by tcUtilityIntf.

Specified by:

setVariant in interface tcUtilityOperationsIntf

Parameters:

psVariant - The locality variant.

close

public void close()

This method will try to remove the bean instance on the server side so that the bean can return to the ready pool.

Specified by:

close in interface tcUtilityOperationsIntf

close

public void close(boolean calledFromFinalize)

This method will notify the object manager that it is finished with the server-side object, and can remove it from the orb.