com.retek.component.shipping
Interface Carrier

All Superinterfaces:
BusinessObject, com.retek.swing11.commons.type.Displayable, DistributedObject
All Known Implementing Classes:
CarrierImpl

public interface Carrier
extends DistributedObject, com.retek.swing11.commons.type.Displayable


Field Summary
static java.lang.String ACCOUNT_NUMBER
           
static java.lang.String DESCRIPTION
           
static java.lang.String DISPLAY_CODE
           
static java.lang.String PICKUP
           
static java.lang.String SHIPMENT_TRACKING_NUMBER_URL_PATTERN
           
static java.lang.String TRACKING_NUMBER_URL_WILDCARD
           
 
Method Summary
 java.lang.String getAccountNumber()
          Get the account number for the billing account number of the carrier.
 RDate getCutOffTime()
           
 java.lang.String getDescription()
           
 java.lang.String getDisplayCode()
           
 java.lang.String getShipmentTrackingUrl(java.lang.String shipmentTrackingNumber)
          Return a valid shipment tracking url for a given shipment tracking number (from a shipment container).
 java.lang.String getShipmentTrackingUrlPattern()
          Return the shipment tracking website url pattern string.
 boolean isDefaultPickupCarrier()
          Get the state of this objects deafult pickup nature in the system.
 boolean isPickup()
          Get the state of this object pickup nature.
 void setAccountNumber(java.lang.String accountNumber)
          Set the account number to the billing account number for a carrier.
 void setCutOffTime(RDate cutOffTime)
           
 void setDefaultPickupCarrier(boolean isDefaultPickupCarrier)
          Set the state of this object default pickup nature in the system.
 void setDescription(java.lang.String description)
           
 void setPickup(boolean canPickup)
          Set the state of this object pickup nature.
 void setShipmentTrackingUrlPattern(java.lang.String shipmentTrackingUrlPattern)
          Set the shipment tracking url pattern for the carrier's tracking website.
 void submit()
           
 
Methods inherited from interface com.retek.commons.component.DistributedObject
debugToString, discardChanges, getContext, getId, getReference, isDeleted, isDirty, isDirtyDeep, isDirtyIgnoreFields, isPersisted, refresh
 
Methods inherited from interface com.retek.commons.component.BusinessObject
getBusinessInterface
 
Methods inherited from interface com.retek.swing11.commons.type.Displayable
toDisplayString
 

Field Detail

ACCOUNT_NUMBER

public static final java.lang.String ACCOUNT_NUMBER
See Also:
Constant Field Values

SHIPMENT_TRACKING_NUMBER_URL_PATTERN

public static final java.lang.String SHIPMENT_TRACKING_NUMBER_URL_PATTERN
See Also:
Constant Field Values

TRACKING_NUMBER_URL_WILDCARD

public static final java.lang.String TRACKING_NUMBER_URL_WILDCARD
See Also:
Constant Field Values

PICKUP

public static final java.lang.String PICKUP
See Also:
Constant Field Values

DISPLAY_CODE

public static final java.lang.String DISPLAY_CODE
See Also:
Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION
See Also:
Constant Field Values
Method Detail

getDisplayCode

public java.lang.String getDisplayCode()
                                throws SystemException
Throws:
SystemException

getCutOffTime

public RDate getCutOffTime()
                    throws SystemException
Throws:
SystemException

getShipmentTrackingUrlPattern

public java.lang.String getShipmentTrackingUrlPattern()
                                               throws SystemException
Return the shipment tracking website url pattern string. Ex. http:\\mycarrier\tracking\number=?

Returns:
String shipment tracking url pattern string
Throws:
SystemException

getShipmentTrackingUrl

public java.lang.String getShipmentTrackingUrl(java.lang.String shipmentTrackingNumber)
                                        throws SystemException,
                                               BusinessException
Return a valid shipment tracking url for a given shipment tracking number (from a shipment container).

Parameters:
shipmentTrackingNumber - tracking number from shipment
Returns:
String shipment tracking url
Throws:
SystemException
BusinessException

getDescription

public java.lang.String getDescription()
                                throws SystemException
Throws:
SystemException

setDescription

public void setDescription(java.lang.String description)
                    throws SystemException
Throws:
SystemException

setCutOffTime

public void setCutOffTime(RDate cutOffTime)
                   throws SystemException
Throws:
SystemException

setShipmentTrackingUrlPattern

public void setShipmentTrackingUrlPattern(java.lang.String shipmentTrackingUrlPattern)
                                   throws SystemException,
                                          BusinessException
Set the shipment tracking url pattern for the carrier's tracking website.

Parameters:
shipmentTrackingUrlPattern - carrier tracking url pattern Ex. http://mycarrier/tracking/number=?
Throws:
SystemException
BusinessException

submit

public void submit()
            throws BusinessException,
                   SystemException
Throws:
BusinessException
SystemException

setAccountNumber

public void setAccountNumber(java.lang.String accountNumber)
                      throws SystemException
Set the account number to the billing account number for a carrier.

Parameters:
accountNumber - the billing account number for the carrier.
Throws:
SystemException

getAccountNumber

public java.lang.String getAccountNumber()
                                  throws SystemException
Get the account number for the billing account number of the carrier.

Returns:
String the accountNumber for the billing account number of the carrier.
Throws:
SystemException

setPickup

public void setPickup(boolean canPickup)
               throws SystemException
Set the state of this object pickup nature. Can pickup?

Throws:
SystemException

isPickup

public boolean isPickup()
                 throws SystemException
Get the state of this object pickup nature. Can pickup?

Returns:
boolean Can this carrier pickup?
Throws:
SystemException

setDefaultPickupCarrier

public void setDefaultPickupCarrier(boolean isDefaultPickupCarrier)
                             throws SystemException
Set the state of this object default pickup nature in the system. Is this the default pickup carrier?

Throws:
SystemException

isDefaultPickupCarrier

public boolean isDefaultPickupCarrier()
                               throws SystemException
Get the state of this objects deafult pickup nature in the system. Is this the default pickup carrier for the system?

Returns:
boolean Is this the default pickup carrier for the system?
Throws:
SystemException


Copyright © 2004 Retek Inc. All Rights Reserved. - Generated at Fri, 10/22/2004 07:28