com.boomi.connector.api

Class Sort

java.lang.Object

com.boomi.connector.api.Sort

All Implemented Interfaces:

Serializable

public class Sort
extends Object
implements Serializable

Java class for Sort complex type.

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

 <complexType name="Sort">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="property" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="sortOrder" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Sort	EMPTY_INSTANCE
protected String	property
protected String	sortOrder

Constructor Summary

Constructors

Constructor and Description
Sort()

Method Summary

Modifier and Type	Method and Description
Sort	copy() Deep copies the fields of the this model into a new instance of this class and returns it.
Sort	copy(boolean isDeep) Copies the fields of the this model (optionally deeply) into a new instance of this class and returns it.
protected Sort	copy(Sort nobj, boolean isDeep) Copies the fields of the this model (optionally deeply) into the given instance and returns it.
boolean	equals(Object o)
String	getProperty() The object property for this simple expression.
String	getSortOrder() The sort order for the given property.
int	hashCode()
void	setProperty(String value) Sets the value of the property property.
void	setSortOrder(String value) Sets the value of the sortOrder property.
String	toString()
Sort	withProperty(String newValue) Sets the property property to the given newValue and returns this instance.
Sort	withSortOrder(String newValue) Sets the sortOrder 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

property

protected String property

sortOrder

protected String sortOrder

EMPTY_INSTANCE

public static final Sort EMPTY_INSTANCE

Constructor Detail

Sort

public Sort()

Method Detail

getProperty

public String getProperty()

The object property for this simple expression. This will be a relative XPath expression (presumed to be rooted within the query object type) which addresses the relevant property.

Example:

     // Object Type
     <xs:complexType name="Order">
         <xs:sequence>
             <xs:element name="item">
                 <xs:complexType>
                     <xs:sequence>
                         <xs:element name="description"/>
                     </xs:sequence>
                     <xs:attribute name="price"/>
                 </xs:complexType>
             </xs:element>
             <xs:element name="userName"/>
         </xs:sequence>
         <xs:attribute name="id"/>
     </xs:complexType>
 
     // property names for addressable properties:
     Order.userName         -> "userName"
     Order.id               -> "[@id]"
     Order.item.description -> "item/description"
     Order.item.price       -> "item[@price]"                                
                                 

Returns:

possible object is String

setProperty

public void setProperty(String value)

Sets the value of the property property.

Parameters:

value - allowed object is String

getSortOrder

public String getSortOrder()

The sort order for the given property.

Returns:

possible object is String

setSortOrder

public void setSortOrder(String value)

Sets the value of the sortOrder 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 Sort copy()

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

copy

public Sort copy(boolean isDeep)

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

copy

protected Sort copy(Sort nobj,
                    boolean isDeep)

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

withProperty

public Sort withProperty(String newValue)

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

withSortOrder

public Sort withSortOrder(String newValue)

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