com.boomi.connector.api

Class ObjectType

java.lang.Object

com.boomi.connector.api.ObjectType

All Implemented Interfaces:

Serializable

public class ObjectType
extends Object
implements Serializable

Basic information about an object which a Connector can manipulate in various ways.

Java class for ObjectType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ObjectType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="helpText" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
       <attribute name="id" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="label" type="{http://www.w3.org/2001/XMLSchema}normalizedString" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectType	EMPTY_INSTANCE
protected String	helpText
protected String	id
protected String	label

Constructor Summary

Constructors

Constructor and Description
ObjectType()

Method Summary

Modifier and Type	Method and Description
ObjectType	copy() Deep copies the fields of the this model into a new instance of this class and returns it.
ObjectType	copy(boolean isDeep) Copies the fields of the this model (optionally deeply) into a new instance of this class and returns it.
protected ObjectType	copy(ObjectType nobj, boolean isDeep) Copies the fields of the this model (optionally deeply) into the given instance and returns it.
boolean	equals(Object o)
String	getHelpText() Optional help text displayed for the object type in the GUI.
String	getId() The actual name of the object type which will be passed in subsequent operations which for this object type.
String	getLabel() Optional text string which will be displayed in the GUI for this object type.
int	hashCode()
void	setHelpText(String value) Sets the value of the helpText property.
void	setId(String value) Sets the value of the id property.
void	setLabel(String value) Sets the value of the label property.
String	toString()
ObjectType	withHelpText(String newValue) Sets the helpText property to the given newValue and returns this instance.
ObjectType	withId(String newValue) Sets the id property to the given newValue and returns this instance.
ObjectType	withLabel(String newValue) Sets the label property to the given newValue and returns this instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

helpText

protected String helpText

id

protected String id

label

protected String label

EMPTY_INSTANCE

public static final ObjectType EMPTY_INSTANCE

Constructor Detail

ObjectType

public ObjectType()

Method Detail

getHelpText

public String getHelpText()

Optional help text displayed for the object type in the GUI.

Returns:

possible object is String

setHelpText

public void setHelpText(String value)

Sets the value of the helpText property.

Parameters:

value - allowed object is String

getId

public String getId()

The actual name of the object type which will be passed in subsequent operations which for this object type.

Returns:

possible object is String

setId

public void setId(String value)

Sets the value of the id property.

Parameters:

value - allowed object is String

getLabel

public String getLabel()

Optional text string which will be displayed in the GUI for this object type. If not defined, the id will be used.

Returns:

possible object is String

setLabel

public void setLabel(String value)

Sets the value of the label property.

Parameters:

value - allowed object is String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

copy

public ObjectType copy()

Deep copies the fields of the this model into a new instance of this class and returns it.

copy

public ObjectType copy(boolean isDeep)

Copies the fields of the this model (optionally deeply) into a new instance of this class and returns it.

copy

protected ObjectType copy(ObjectType nobj,
                          boolean isDeep)

Copies the fields of the this model (optionally deeply) into the given instance and returns it.

withHelpText

public ObjectType withHelpText(String newValue)

Sets the helpText property to the given newValue and returns this instance.

withId

public ObjectType withId(String newValue)

Sets the id property to the given newValue and returns this instance.

withLabel

public ObjectType withLabel(String newValue)

Sets the label property to the given newValue and returns this instance.