com.mapinfo.geocode.api

Interface CustomObject

All Known Implementing Classes:

CustomObjectDescriptor

public interface CustomObject

This class defines a custom object which is used by an Operation. The CustomObject represents a parameter of an Operation where that parameter is not already defined by classes in the package such as Address or Preferences. CustomObjects are defined for future custom operation support.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get description of custom object
List<CustomObjectMember>	getMembers() get members of custom object.
String	getName() Get name of custom object
void	setDescription(String desc) Set description of custom object
void	setMembers(List<CustomObjectMember> members) Set members of custom object
void	setName(String name) Set name of custom object

Method Detail

getName

String getName()

Get name of custom object

Returns:

name of custom object

setName

void setName(String name)

Set name of custom object

Parameters:

name - - name of custom object

getDescription

String getDescription()

Get description of custom object

Returns:

description of custom object

setDescription

void setDescription(String desc)

Set description of custom object

Parameters:

desc - - description of custom object

getMembers

List<CustomObjectMember> getMembers()

get members of custom object. Each member has a name and a defined InputParam object decribing the input.

Returns:

members of custom object

setMembers

void setMembers(List<CustomObjectMember> members)

Set members of custom object

Parameters:

members - - members of custom object