Package com.webmethods.portal.service.meta2.thing

Interface IThingNameInfo

All Superinterfaces:

IThingNameView

All Known Subinterfaces:

IArchived, IBizPolicyData, ICategory, IContainer, IContent, IDirServiceThing, IFolder, IForm, IForum, IGroup, IHandlerData, ILink, IMechanicsData, IMessage, IPortlet, IPrincipal, IRelation, IRole, ISchedule, IServiceThing, IStyle, ITemplate, IThing, IThingComponentData, ITopic, ITopic, IUser, IWorkspace, IXType

public interface IThingNameInfo
extends IThingNameView

Get and set name data. We store name/desc for each language. The first language a thing was assigned a name/desc in becomes the "default" language. getName(java.lang.String) and getDescription(java.lang.String) return the name/desc in the current language, or in the default language getThingLang() if an entry in the current language is not found

See Also:

• IThing
• IThingNameView

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IThingNameInfo.INameAtom	return structure for getNames

Method Summary

Modifier and Type	Method	Description
Collection<String>	getAllLanguages()	Returns a collection of all languages that name/description exist for this thing
String	getDescription(String lang)	gets description for default language
String	getName(String lang)	Gets the name in the default language
Collection<IThingNameInfo.INameAtom>	getNames()	get a list of all names as name atoms
String	getThingLang()
void	putNameDesc(String name, String desc, String strISOLanguage)	put the name & desc for a given lang in the cache
void	setDescription(String desc)	sets description in default language
void	setDescription(String desc, String strISOLanguage)	sets description in specified language
void	setName(String name)	sets the name in the default language
void	setName(String name, String strISOLanguage)	sets name in specified language
void	setNameDesc(String name, String desc, String strISOLanguage)	set the name/desc in the DB for a given lang It's more effiecient to call these together

Methods inherited from interface com.webmethods.portal.service.meta2.thing.IThingNameView

getDescription, getName

Method Details

getThingLang

String getThingLang()
             throws MetaException

Returns:

the language of this thing by checking the name The first name entered indicates the default language.

Throws:

MetaException

getName

String getName(String lang)
        throws MetaException

Gets the name in the default language

Returns:

String

Throws:

MetaException - if thing doesn't exist or DB error

setName

void setName(String name)
      throws MetaException

sets the name in the default language

Parameters:

name - 256 char max

Throws:

MetaException - if thing doesn't exist or DB error

setName

void setName(String name,
 String strISOLanguage)
      throws MetaException

sets name in specified language

Parameters:

name - 256 char max

strISOLanguage - language code

Throws:

MetaException - if thing doesn't exist or DB error

getDescription

String getDescription(String lang)
               throws MetaException

gets description for default language

Returns:

String

Throws:

MetaException - if thing doesn't exist or DB error

setDescription

void setDescription(String desc)
             throws MetaException

sets description in default language

Parameters:

desc - 256 char max

Throws:

MetaException - if thing doesn't exist or DB error

setDescription

void setDescription(String desc,
 String strISOLanguage)
             throws MetaException

sets description in specified language

Parameters:

desc - 256 char max

strISOLanguage - language code

Throws:

MetaException - if thing doesn't exist or DB error

putNameDesc

void putNameDesc(String name,
 String desc,
 String strISOLanguage)

put the name & desc for a given lang in the cache

Parameters:

strISOLanguage - null==default lang

setNameDesc

void setNameDesc(String name,
 String desc,
 String strISOLanguage)
          throws MetaException

set the name/desc in the DB for a given lang It's more effiecient to call these together

Parameters:

strISOLanguage - null==default lang

Throws:

MetaException

getNames

Collection<IThingNameInfo.INameAtom> getNames()
                                       throws MetaException

get a list of all names as name atoms

Throws:

MetaException

getAllLanguages

Collection<String> getAllLanguages()
                            throws MetaException

Returns a collection of all languages that name/description exist for this thing

Returns:

Collection of String

Throws:

MetaException