org.brapi.v2.model.geno

Class BrAPIVendorOrder

java.lang.Object

org.brapi.v2.model.geno.BrAPIVendorOrder

public class BrAPIVendorOrder
extends Object

The details of a vendor order

Constructor Summary

Constructors

Constructor and Description
BrAPIVendorOrder()

Method Summary

Modifier and Type	Method and Description
BrAPIVendorOrder	addServiceIdsItem(String serviceIdsItem)
BrAPIVendorOrder	clientId(String clientId)
boolean	equals(Object o)
String	getClientId() A unique, alpha-numeric ID which identifies the client to the vendor.
Integer	getNumberOfSamples() The total number of samples contained in this request.
String	getOrderId() The order id returned by the vendor when the order was successfully submitted.
Map<String,String>	getRequiredServiceInfo() A map of additional data required by the requested service.
List<String>	getServiceIds() A list of unique, alpha-numeric ID which identify the requested services to be applied to this order.
int	hashCode()
BrAPIVendorOrder	numberOfSamples(Integer numberOfSamples)
BrAPIVendorOrder	orderId(String orderId)
BrAPIVendorOrder	putRequiredServiceInfoItem(String key, String requiredServiceInfoItem)
BrAPIVendorOrder	requiredServiceInfo(Map<String,String> requiredServiceInfo)
BrAPIVendorOrder	serviceIds(List<String> serviceIds)
void	setClientId(String clientId)
void	setNumberOfSamples(Integer numberOfSamples)
void	setOrderId(String orderId)
void	setRequiredServiceInfo(Map<String,String> requiredServiceInfo)
void	setServiceIds(List<String> serviceIds)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIVendorOrder

public BrAPIVendorOrder()

Method Detail

clientId

public BrAPIVendorOrder clientId(String clientId)

getClientId

public String getClientId()

A unique, alpha-numeric ID which identifies the client to the vendor. Used to connect the order to the correct billing and contact info.

Returns:

clientId

setClientId

public void setClientId(String clientId)

numberOfSamples

public BrAPIVendorOrder numberOfSamples(Integer numberOfSamples)

getNumberOfSamples

public Integer getNumberOfSamples()

The total number of samples contained in this request. Used for billing and basic validation of the request.

Returns:

numberOfSamples

setNumberOfSamples

public void setNumberOfSamples(Integer numberOfSamples)

orderId

public BrAPIVendorOrder orderId(String orderId)

getOrderId

public String getOrderId()

The order id returned by the vendor when the order was successfully submitted.

Returns:

orderId

setOrderId

public void setOrderId(String orderId)

requiredServiceInfo

public BrAPIVendorOrder requiredServiceInfo(Map<String,String> requiredServiceInfo)

putRequiredServiceInfoItem

public BrAPIVendorOrder putRequiredServiceInfoItem(String key,
                                                   String requiredServiceInfoItem)

getRequiredServiceInfo

public Map<String,String> getRequiredServiceInfo()

A map of additional data required by the requested service. This includes things like Volume and Concentration.

Returns:

requiredServiceInfo

setRequiredServiceInfo

public void setRequiredServiceInfo(Map<String,String> requiredServiceInfo)

serviceIds

public BrAPIVendorOrder serviceIds(List<String> serviceIds)

addServiceIdsItem

public BrAPIVendorOrder addServiceIdsItem(String serviceIdsItem)

getServiceIds

public List<String> getServiceIds()

A list of unique, alpha-numeric ID which identify the requested services to be applied to this order. A Vendor Service defines what platform, technology, and markers will be used. A list of available service IDs can be retrieved from the Vendor Specs.

Returns:

serviceIds

setServiceIds

public void setServiceIds(List<String> serviceIds)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object