com.softlayer.api.service.account.Shipment

@ApiType("SoftLayer_Account_Shipment")
public class Shipment
extends Entity

The SoftLayer_Account_Shipment data type contains information relating to a shipment. Basic information such as addresses, the shipment courier, and any tracking information for as shipment is accessible with this data type.

See Also:: SoftLayer_Account_Shipment

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Shipment.Mask`
`static interface`	`Shipment.Service`	SoftLayer's shipment service allows the user to access information pertaining to a shipment from the user to SoftLayer or from SoftLayer to the user.
`static interface`	`Shipment.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected Account`	`account`	The account to which the shipment belongs.
`protected Long`	`accountId`	The account id of the shipment.
`protected boolean`	`accountIdSpecified`
`protected Courier`	`courier`	The courier handling the shipment.
`protected Long`	`courierId`	The courier id of the shipment.
`protected boolean`	`courierIdSpecified`
`protected String`	`courierName`	The courier name of the shipment.
`protected boolean`	`courierNameSpecified`
`protected Employee`	`createEmployee`	The employee who created the shipment.
`protected Customer`	`createUser`	The customer user who created the shipment.
`protected Long`	`createUserId`	The create user id of the shipment.
`protected boolean`	`createUserIdSpecified`
`protected Currency`	`currency`
`protected Address`	`destinationAddress`	The address at which the shipment is received.
`protected Long`	`destinationAddressId`	The destination address id of the shipment.
`protected boolean`	`destinationAddressIdSpecified`
`protected GregorianCalendar`	`destinationDate`	The destination date of the shipment.
`protected boolean`	`destinationDateSpecified`
`protected Long`	`id`	The unique id of the shipment.
`protected boolean`	`idSpecified`
`protected Data`	`masterTrackingData`	The one master tracking data for the shipment.
`protected Employee`	`modifyEmployee`	The employee who last modified the shipment.
`protected Customer`	`modifyUser`	The customer user who last modified the shipment.
`protected Long`	`modifyUserId`	The modify user id of the shipment.
`protected boolean`	`modifyUserIdSpecified`
`protected String`	`note`	The shipment note (special handling instructions).
`protected boolean`	`noteSpecified`
`protected Address`	`originationAddress`	The address from which the shipment is sent.
`protected Long`	`originationAddressId`	The origination address id of the shipment.
`protected boolean`	`originationAddressIdSpecified`
`protected GregorianCalendar`	`originationDate`	The origination date of the shipment.
`protected boolean`	`originationDateSpecified`
`protected Long`	`shipmentItemCount`	A count of the items in the shipment.
`protected List<Item>`	`shipmentItems`	The items in the shipment.
`protected Status`	`status`	The status of the shipment.
`protected Long`	`statusId`	The status id of the shipment.
`protected boolean`	`statusIdSpecified`
`protected List<Data>`	`trackingData`	All tracking data for the shipment and packages.
`protected Long`	`trackingDataCount`	A count of all tracking data for the shipment and packages.
`protected Type`	`type`	The type of shipment (e.g.
`protected Long`	`typeId`	The type id of the shipment.
`protected boolean`	`typeIdSpecified`
`protected Address`	`viaAddress`	The address at which the shipment is received.
`protected Long`	`viaAddressId`	The via address id of the shipment.
`protected boolean`	`viaAddressIdSpecified`

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor Description

Shipment()

Method Summary

Modifier and Type	Method	Description
`Shipment.Service`	`asService(ApiClient client)`
`Account`	`getAccount()`
`Long`	`getAccountId()`
`Courier`	`getCourier()`
`Long`	`getCourierId()`
`String`	`getCourierName()`
`Employee`	`getCreateEmployee()`
`Customer`	`getCreateUser()`
`Long`	`getCreateUserId()`
`Currency`	`getCurrency()`
`Address`	`getDestinationAddress()`
`Long`	`getDestinationAddressId()`
`GregorianCalendar`	`getDestinationDate()`
`Long`	`getId()`
`Data`	`getMasterTrackingData()`
`Employee`	`getModifyEmployee()`
`Customer`	`getModifyUser()`
`Long`	`getModifyUserId()`
`String`	`getNote()`
`Address`	`getOriginationAddress()`
`Long`	`getOriginationAddressId()`
`GregorianCalendar`	`getOriginationDate()`
`Long`	`getShipmentItemCount()`
`List<Item>`	`getShipmentItems()`
`Status`	`getStatus()`
`Long`	`getStatusId()`
`List<Data>`	`getTrackingData()`
`Long`	`getTrackingDataCount()`
`Type`	`getType()`
`Long`	`getTypeId()`
`Address`	`getViaAddress()`
`Long`	`getViaAddressId()`
`boolean`	`isAccountIdSpecified()`
`boolean`	`isCourierIdSpecified()`
`boolean`	`isCourierNameSpecified()`
`boolean`	`isCreateUserIdSpecified()`
`boolean`	`isDestinationAddressIdSpecified()`
`boolean`	`isDestinationDateSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isModifyUserIdSpecified()`
`boolean`	`isNoteSpecified()`
`boolean`	`isOriginationAddressIdSpecified()`
`boolean`	`isOriginationDateSpecified()`
`boolean`	`isStatusIdSpecified()`
`boolean`	`isTypeIdSpecified()`
`boolean`	`isViaAddressIdSpecified()`
`static Shipment.Service`	`service(ApiClient client)`
`static Shipment.Service`	`service(ApiClient client, Long id)`
`void`	`setAccount(Account account)`
`void`	`setAccountId(Long accountId)`
`void`	`setCourier(Courier courier)`
`void`	`setCourierId(Long courierId)`
`void`	`setCourierName(String courierName)`
`void`	`setCreateEmployee(Employee createEmployee)`
`void`	`setCreateUser(Customer createUser)`
`void`	`setCreateUserId(Long createUserId)`
`void`	`setCurrency(Currency currency)`
`void`	`setDestinationAddress(Address destinationAddress)`
`void`	`setDestinationAddressId(Long destinationAddressId)`
`void`	`setDestinationDate(GregorianCalendar destinationDate)`
`void`	`setId(Long id)`
`void`	`setMasterTrackingData(Data masterTrackingData)`
`void`	`setModifyEmployee(Employee modifyEmployee)`
`void`	`setModifyUser(Customer modifyUser)`
`void`	`setModifyUserId(Long modifyUserId)`
`void`	`setNote(String note)`
`void`	`setOriginationAddress(Address originationAddress)`
`void`	`setOriginationAddressId(Long originationAddressId)`
`void`	`setOriginationDate(GregorianCalendar originationDate)`
`void`	`setShipmentItemCount(Long shipmentItemCount)`
`void`	`setStatus(Status status)`
`void`	`setStatusId(Long statusId)`
`void`	`setTrackingDataCount(Long trackingDataCount)`
`void`	`setType(Type type)`
`void`	`setTypeId(Long typeId)`
`void`	`setViaAddress(Address viaAddress)`
`void`	`setViaAddressId(Long viaAddressId)`
`void`	`unsetAccountId()`
`void`	`unsetCourierId()`
`void`	`unsetCourierName()`
`void`	`unsetCreateUserId()`
`void`	`unsetDestinationAddressId()`
`void`	`unsetDestinationDate()`
`void`	`unsetId()`
`void`	`unsetModifyUserId()`
`void`	`unsetNote()`
`void`	`unsetOriginationAddressId()`
`void`	`unsetOriginationDate()`
`void`	`unsetStatusId()`
`void`	`unsetTypeId()`
`void`	`unsetViaAddressId()`

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- account
  
  @ApiProperty protected Account account
  
  The account to which the shipment belongs.
- courier
  
  @ApiProperty protected Courier courier
  
  The courier handling the shipment.
- createEmployee
  
  @ApiProperty protected Employee createEmployee
  
  The employee who created the shipment.
- createUser
  
  @ApiProperty protected Customer createUser
  
  The customer user who created the shipment.
- currency
  
  @ApiProperty protected Currency currency
- destinationAddress
  
  @ApiProperty protected Address destinationAddress
  
  The address at which the shipment is received.
- masterTrackingData
  
  @ApiProperty protected Data masterTrackingData
  
  The one master tracking data for the shipment.
- modifyEmployee
  
  @ApiProperty protected Employee modifyEmployee
  
  The employee who last modified the shipment.
- modifyUser
  
  @ApiProperty protected Customer modifyUser
  
  The customer user who last modified the shipment.
- originationAddress
  
  @ApiProperty protected Address originationAddress
  
  The address from which the shipment is sent.
- shipmentItems
  
  @ApiProperty protected List<Item> shipmentItems
  
  The items in the shipment.
- status
  
  @ApiProperty protected Status status
  
  The status of the shipment.
- trackingData
  
  @ApiProperty protected List<Data> trackingData
  
  All tracking data for the shipment and packages.
- type
  
  @ApiProperty protected Type type
  
  The type of shipment (e.g. for Data Transfer Service or Colocation Service).
- viaAddress
  
  @ApiProperty protected Address viaAddress
  
  The address at which the shipment is received.
- accountId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long accountId
  
  The account id of the shipment.
- accountIdSpecified
  
  protected boolean accountIdSpecified
- courierId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long courierId
  
  The courier id of the shipment.
- courierIdSpecified
  
  protected boolean courierIdSpecified
- courierName
  
  @ApiProperty(canBeNullOrNotSet=true) protected String courierName
  
  The courier name of the shipment.
- courierNameSpecified
  
  protected boolean courierNameSpecified
- createUserId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long createUserId
  
  The create user id of the shipment.
- createUserIdSpecified
  
  protected boolean createUserIdSpecified
- destinationAddressId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long destinationAddressId
  
  The destination address id of the shipment.
- destinationAddressIdSpecified
  
  protected boolean destinationAddressIdSpecified
- destinationDate
  
  @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar destinationDate
  
  The destination date of the shipment.
- destinationDateSpecified
  
  protected boolean destinationDateSpecified
- id
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long id
  
  The unique id of the shipment.
- idSpecified
  
  protected boolean idSpecified
- modifyUserId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long modifyUserId
  
  The modify user id of the shipment.
- modifyUserIdSpecified
  
  protected boolean modifyUserIdSpecified
- note
  
  @ApiProperty(canBeNullOrNotSet=true) protected String note
  
  The shipment note (special handling instructions).
- noteSpecified
  
  protected boolean noteSpecified
- originationAddressId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long originationAddressId
  
  The origination address id of the shipment.
- originationAddressIdSpecified
  
  protected boolean originationAddressIdSpecified
- originationDate
  
  @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar originationDate
  
  The origination date of the shipment.
- originationDateSpecified
  
  protected boolean originationDateSpecified
- statusId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long statusId
  
  The status id of the shipment.
- statusIdSpecified
  
  protected boolean statusIdSpecified
- typeId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long typeId
  
  The type id of the shipment.
- typeIdSpecified
  
  protected boolean typeIdSpecified
- viaAddressId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long viaAddressId
  
  The via address id of the shipment.
- viaAddressIdSpecified
  
  protected boolean viaAddressIdSpecified
- shipmentItemCount
  
  @ApiProperty protected Long shipmentItemCount
  
  A count of the items in the shipment.
- trackingDataCount
  
  @ApiProperty protected Long trackingDataCount
  
  A count of all tracking data for the shipment and packages.
Constructor Details
- Shipment
  
  public Shipment()
Method Details
- getAccount
  
  public Account getAccount()
- setAccount
  
  public void setAccount(Account account)
- getCourier
  
  public Courier getCourier()
- setCourier
  
  public void setCourier(Courier courier)
- getCreateEmployee
  
  public Employee getCreateEmployee()
- setCreateEmployee
  
  public void setCreateEmployee(Employee createEmployee)
- getCreateUser
  
  public Customer getCreateUser()
- setCreateUser
  
  public void setCreateUser(Customer createUser)
- getCurrency
  
  public Currency getCurrency()
- setCurrency
  
  public void setCurrency(Currency currency)
- getDestinationAddress
  
  public Address getDestinationAddress()
- setDestinationAddress
  
  public void setDestinationAddress(Address destinationAddress)
- getMasterTrackingData
  
  public Data getMasterTrackingData()
- setMasterTrackingData
  
  public void setMasterTrackingData(Data masterTrackingData)
- getModifyEmployee
  
  public Employee getModifyEmployee()
- setModifyEmployee
  
  public void setModifyEmployee(Employee modifyEmployee)
- getModifyUser
  
  public Customer getModifyUser()
- setModifyUser
  
  public void setModifyUser(Customer modifyUser)
- getOriginationAddress
  
  public Address getOriginationAddress()
- setOriginationAddress
  
  public void setOriginationAddress(Address originationAddress)
- getShipmentItems
  
  public List<Item> getShipmentItems()
- getStatus
  
  public Status getStatus()
- setStatus
  
  public void setStatus(Status status)
- getTrackingData
  
  public List<Data> getTrackingData()
- getType
  
  public Type getType()
- setType
  
  public void setType(Type type)
- getViaAddress
  
  public Address getViaAddress()
- setViaAddress
  
  public void setViaAddress(Address viaAddress)
- getAccountId
  
  public Long getAccountId()
- setAccountId
  
  public void setAccountId(Long accountId)
- isAccountIdSpecified
  
  public boolean isAccountIdSpecified()
- unsetAccountId
  
  public void unsetAccountId()
- getCourierId
  
  public Long getCourierId()
- setCourierId
  
  public void setCourierId(Long courierId)
- isCourierIdSpecified
  
  public boolean isCourierIdSpecified()
- unsetCourierId
  
  public void unsetCourierId()
- getCourierName
  
  public String getCourierName()
- setCourierName
  
  public void setCourierName(String courierName)
- isCourierNameSpecified
  
  public boolean isCourierNameSpecified()
- unsetCourierName
  
  public void unsetCourierName()
- getCreateUserId
  
  public Long getCreateUserId()
- setCreateUserId
  
  public void setCreateUserId(Long createUserId)
- isCreateUserIdSpecified
  
  public boolean isCreateUserIdSpecified()
- unsetCreateUserId
  
  public void unsetCreateUserId()
- getDestinationAddressId
  
  public Long getDestinationAddressId()
- setDestinationAddressId
  
  public void setDestinationAddressId(Long destinationAddressId)
- isDestinationAddressIdSpecified
  
  public boolean isDestinationAddressIdSpecified()
- unsetDestinationAddressId
  
  public void unsetDestinationAddressId()
- getDestinationDate
  
  public GregorianCalendar getDestinationDate()
- setDestinationDate
  
  public void setDestinationDate(GregorianCalendar destinationDate)
- isDestinationDateSpecified
  
  public boolean isDestinationDateSpecified()
- unsetDestinationDate
  
  public void unsetDestinationDate()
- getId
  
  public Long getId()
- setId
  
  public void setId(Long id)
- isIdSpecified
  
  public boolean isIdSpecified()
- unsetId
  
  public void unsetId()
- getModifyUserId
  
  public Long getModifyUserId()
- setModifyUserId
  
  public void setModifyUserId(Long modifyUserId)
- isModifyUserIdSpecified
  
  public boolean isModifyUserIdSpecified()
- unsetModifyUserId
  
  public void unsetModifyUserId()
- getNote
  
  public String getNote()
- setNote
  
  public void setNote(String note)
- isNoteSpecified
  
  public boolean isNoteSpecified()
- unsetNote
  
  public void unsetNote()
- getOriginationAddressId
  
  public Long getOriginationAddressId()
- setOriginationAddressId
  
  public void setOriginationAddressId(Long originationAddressId)
- isOriginationAddressIdSpecified
  
  public boolean isOriginationAddressIdSpecified()
- unsetOriginationAddressId
  
  public void unsetOriginationAddressId()
- getOriginationDate
  
  public GregorianCalendar getOriginationDate()
- setOriginationDate
  
  public void setOriginationDate(GregorianCalendar originationDate)
- isOriginationDateSpecified
  
  public boolean isOriginationDateSpecified()
- unsetOriginationDate
  
  public void unsetOriginationDate()
- getStatusId
  
  public Long getStatusId()
- setStatusId
  
  public void setStatusId(Long statusId)
- isStatusIdSpecified
  
  public boolean isStatusIdSpecified()
- unsetStatusId
  
  public void unsetStatusId()
- getTypeId
  
  public Long getTypeId()
- setTypeId
  
  public void setTypeId(Long typeId)
- isTypeIdSpecified
  
  public boolean isTypeIdSpecified()
- unsetTypeId
  
  public void unsetTypeId()
- getViaAddressId
  
  public Long getViaAddressId()
- setViaAddressId
  
  public void setViaAddressId(Long viaAddressId)
- isViaAddressIdSpecified
  
  public boolean isViaAddressIdSpecified()
- unsetViaAddressId
  
  public void unsetViaAddressId()
- getShipmentItemCount
  
  public Long getShipmentItemCount()
- setShipmentItemCount
  
  public void setShipmentItemCount(Long shipmentItemCount)
- getTrackingDataCount
  
  public Long getTrackingDataCount()
- setTrackingDataCount
  
  public void setTrackingDataCount(Long trackingDataCount)
- asService
  
  public Shipment.Service asService(ApiClient client)
- service
  
  public static Shipment.Service service(ApiClient client)
- service
  
  public static Shipment.Service service(ApiClient client, Long id)

Class Shipment

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details