Package com.softlayer.api.service.account.shipment.tracking

Interface Data.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Data

@ApiService("SoftLayer_Account_Shipment_Tracking_Data")
public static interface Data.Service
extends Service

SoftLayer's tracking data service allows the user to access and manage tracking information on shipments sent from the user to SoftLayer or from SoftLayer to the user.

See Also:

SoftLayer_Account_Shipment_Tracking_Data

Method Summary

Modifier and Type	Method	Description
Data.ServiceAsync	asAsync()	Get an async version of this service
Data	createObject(Data templateObject)	Create a new shipment tracking data.
List<Data>	createObjects(List<Data> templateObjects)	Create a new shipment tracking data.
Boolean	deleteObject()	deleteObject permanently removes a shipment tracking datum (number)
Boolean	editObject(Data templateObject)	Edit the properties of a tracking data record by passing in a modified instance of a SoftLayer_Account_Shipment_Tracking_Data object.
Employee	getCreateEmployee()	The employee who created the tracking datum.
Customer	getCreateUser()	The customer user who created the tracking datum.
Employee	getModifyEmployee()	The employee who last modified the tracking datum.
Customer	getModifyUser()	The customer user who last modified the tracking datum.
Data	getObject()
Shipment	getShipment()	The shipment of the tracking datum.
void	setMask(Data.Mask mask)
Data.Mask	withMask()	Use the existing mask on this service or create it if not present
Data.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 Detail

asAsync

Data.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Data.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

Data.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(Data.Mask mask)

createObject

@ApiMethod
Data createObject(Data templateObject)

Create a new shipment tracking data. The ''shipmentId'', ''sequence'', and ''trackingData'' properties in the templateObject parameter are required parameters to create a tracking data record.

See Also:

SoftLayer_Account_Shipment_Tracking_Data::createObject

createObjects

@ApiMethod
List<Data> createObjects(List<Data> templateObjects)

Create a new shipment tracking data. The ''shipmentId'', ''sequence'', and ''trackingData'' properties of each templateObject in the templateObjects array are required parameters to create a tracking data record.

See Also:

SoftLayer_Account_Shipment_Tracking_Data::createObjects

deleteObject

@ApiMethod(instanceRequired=true)
Boolean deleteObject()

deleteObject permanently removes a shipment tracking datum (number)

See Also:

SoftLayer_Account_Shipment_Tracking_Data::deleteObject

editObject

@ApiMethod(instanceRequired=true)
Boolean editObject(Data templateObject)

Edit the properties of a tracking data record by passing in a modified instance of a SoftLayer_Account_Shipment_Tracking_Data object.

See Also:

SoftLayer_Account_Shipment_Tracking_Data::editObject

getObject

@ApiMethod(instanceRequired=true)
Data getObject()

See Also:

SoftLayer_Account_Shipment_Tracking_Data::getObject

getCreateEmployee

@ApiMethod(instanceRequired=true)
Employee getCreateEmployee()

The employee who created the tracking datum.

See Also:

SoftLayer_Account_Shipment_Tracking_Data::getCreateEmployee

getCreateUser

@ApiMethod(instanceRequired=true)
Customer getCreateUser()

The customer user who created the tracking datum.

See Also:

SoftLayer_Account_Shipment_Tracking_Data::getCreateUser

getModifyEmployee

@ApiMethod(instanceRequired=true)
Employee getModifyEmployee()

The employee who last modified the tracking datum.

See Also:

SoftLayer_Account_Shipment_Tracking_Data::getModifyEmployee

getModifyUser

@ApiMethod(instanceRequired=true)
Customer getModifyUser()

The customer user who last modified the tracking datum.

See Also:

SoftLayer_Account_Shipment_Tracking_Data::getModifyUser

getShipment

@ApiMethod(instanceRequired=true)
Shipment getShipment()

The shipment of the tracking datum.

See Also:

SoftLayer_Account_Shipment_Tracking_Data::getShipment