All Superinterfaces:: Maskable, ResultLimitable, Service

Enclosing class:: Shipment

@ApiService("SoftLayer_Account_Shipment")
public static interface Shipment.Service
extends 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.

See Also:: SoftLayer_Account_Shipment

Method Summary

Modifier and Type	Method	Description
`Shipment.ServiceAsync`	`asAsync()`	Get an async version of this service
`Boolean`	`editObject(Shipment templateObject)`	Edit the properties of a shipment record by passing in a modified instance of a SoftLayer_Account_Shipment object.
`Account`	`getAccount()`	The account to which the shipment belongs.
`List<Courier>`	`getAllCouriers()`	Retrieve a list of available shipping couriers.
`List<Courier>`	`getAllCouriersByType(String courierTypeKeyName)`	Retrieve a list of available shipping couriers.
`List<Status>`	`getAllShipmentStatuses()`	Retrieve a a list of shipment statuses.
`List<Type>`	`getAllShipmentTypes()`	Retrieve a a list of shipment types.
`Courier`	`getCourier()`	The courier handling the shipment.
`Employee`	`getCreateEmployee()`	The employee who created the shipment.
`Customer`	`getCreateUser()`	The customer user who created the shipment.
`Currency`	`getCurrency()`
`Address`	`getDestinationAddress()`	The address at which the shipment is received.
`Data`	`getMasterTrackingData()`	The one master tracking data for the shipment.
`Employee`	`getModifyEmployee()`	The employee who last modified the shipment.
`Customer`	`getModifyUser()`	The customer user who last modified the shipment.
`Shipment`	`getObject()`
`Address`	`getOriginationAddress()`	The address from which the shipment is sent.
`List<Item>`	`getShipmentItems()`	The items in the shipment.
`Status`	`getStatus()`	The status of the shipment.
`List<Data>`	`getTrackingData()`	All tracking data for the shipment and packages.
`Type`	`getType()`	The type of shipment (e.g.
`Address`	`getViaAddress()`	The address at which the shipment is received.
`void`	`setMask(Shipment.Mask mask)`
`Shipment.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Shipment.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details
- asAsync
  
  Shipment.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface Service
- withNewMask
  
  Shipment.Mask withNewMask()
  
  Description copied from interface: Maskable
  
  Overwrite the existing mask on this service with a new one and return it
  
  Specified by:
  
  withNewMask in interface Maskable
- withMask
  
  Shipment.Mask withMask()
  
  Description copied from interface: Maskable
  
  Use the existing mask on this service or create it if not present
  
  Specified by:
  
  withMask in interface Maskable
- setMask
  
  void setMask(Shipment.Mask mask)
- editObject
  
  @ApiMethod(instanceRequired=true) Boolean editObject(Shipment templateObject)
  
  Edit the properties of a shipment record by passing in a modified instance of a SoftLayer_Account_Shipment object.
  
  See Also:
  
  SoftLayer_Account_Shipment::editObject
- getAllCouriers
  
  @ApiMethod List<Courier> getAllCouriers()
  
  Retrieve a list of available shipping couriers.
  
  See Also:
  
  SoftLayer_Account_Shipment::getAllCouriers
- getAllCouriersByType
  
  @ApiMethod List<Courier> getAllCouriersByType(String courierTypeKeyName)
  
  Retrieve a list of available shipping couriers.
  
  See Also:
  
  SoftLayer_Account_Shipment::getAllCouriersByType
- getAllShipmentStatuses
  
  @ApiMethod List<Status> getAllShipmentStatuses()
  
  Retrieve a a list of shipment statuses.
  
  See Also:
  
  SoftLayer_Account_Shipment::getAllShipmentStatuses
- getAllShipmentTypes
  
  @ApiMethod List<Type> getAllShipmentTypes()
  
  Retrieve a a list of shipment types.
  
  See Also:
  
  SoftLayer_Account_Shipment::getAllShipmentTypes
- getObject
  
  @ApiMethod(instanceRequired=true) Shipment getObject()
  
  See Also:
  
  SoftLayer_Account_Shipment::getObject
- getAccount
  
  @ApiMethod(instanceRequired=true) Account getAccount()
  
  The account to which the shipment belongs.
  
  See Also:
  
  SoftLayer_Account_Shipment::getAccount
- getCourier
  
  @ApiMethod(instanceRequired=true) Courier getCourier()
  
  The courier handling the shipment.
  
  See Also:
  
  SoftLayer_Account_Shipment::getCourier
- getCreateEmployee
  
  @ApiMethod(instanceRequired=true) Employee getCreateEmployee()
  
  The employee who created the shipment.
  
  See Also:
  
  SoftLayer_Account_Shipment::getCreateEmployee
- getCreateUser
  
  @ApiMethod(instanceRequired=true) Customer getCreateUser()
  
  The customer user who created the shipment.
  
  See Also:
  
  SoftLayer_Account_Shipment::getCreateUser
- getCurrency
  
  @ApiMethod(instanceRequired=true) Currency getCurrency()
  
  See Also:
  
  SoftLayer_Account_Shipment::getCurrency
- getDestinationAddress
  
  @ApiMethod(instanceRequired=true) Address getDestinationAddress()
  
  The address at which the shipment is received.
  
  See Also:
  
  SoftLayer_Account_Shipment::getDestinationAddress
- getMasterTrackingData
  
  @ApiMethod(instanceRequired=true) Data getMasterTrackingData()
  
  The one master tracking data for the shipment.
  
  See Also:
  
  SoftLayer_Account_Shipment::getMasterTrackingData
- getModifyEmployee
  
  @ApiMethod(instanceRequired=true) Employee getModifyEmployee()
  
  The employee who last modified the shipment.
  
  See Also:
  
  SoftLayer_Account_Shipment::getModifyEmployee
- getModifyUser
  
  @ApiMethod(instanceRequired=true) Customer getModifyUser()
  
  The customer user who last modified the shipment.
  
  See Also:
  
  SoftLayer_Account_Shipment::getModifyUser
- getOriginationAddress
  
  @ApiMethod(instanceRequired=true) Address getOriginationAddress()
  
  The address from which the shipment is sent.
  
  See Also:
  
  SoftLayer_Account_Shipment::getOriginationAddress
- getShipmentItems
  
  @ApiMethod(instanceRequired=true) List<Item> getShipmentItems()
  
  The items in the shipment.
  
  See Also:
  
  SoftLayer_Account_Shipment::getShipmentItems
- getStatus
  
  @ApiMethod(instanceRequired=true) Status getStatus()
  
  The status of the shipment.
  
  See Also:
  
  SoftLayer_Account_Shipment::getStatus
- getTrackingData
  
  @ApiMethod(instanceRequired=true) List<Data> getTrackingData()
  
  All tracking data for the shipment and packages.
  
  See Also:
  
  SoftLayer_Account_Shipment::getTrackingData
- getType
  
  @ApiMethod(instanceRequired=true) Type getType()
  
  The type of shipment (e.g. for Data Transfer Service or Colocation Service).
  
  See Also:
  
  SoftLayer_Account_Shipment::getType
- getViaAddress
  
  @ApiMethod(instanceRequired=true) Address getViaAddress()
  
  The address at which the shipment is received.
  
  See Also:
  
  SoftLayer_Account_Shipment::getViaAddress

Interface Shipment.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details