TransferResource (Apache OODT 0.7 API)

java.lang.Object
- org.apache.oodt.cas.product.jaxrs.resources.TransferResource

```
public class TransferResource
extends Object
```
A JAX-RS resource representing a FileTransferStatus.

Version:

$Revision$

Author:

rlaidlaw

Constructor Summary

Constructors
Constructor and Description
`TransferResource()` Default constructor required by JAXB.
`TransferResource(Product product, Metadata metadata, FileTransferStatus status)` Constructor that sets the `FileTransferStatus` for the resource.

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`getBytesTransferred()` Gets the bytes transferred status of the file transfer.
`String`	`getDataStoreReference()` Gets the data store reference for the reference.
`long`	`getFileSize()` Gets the file size for the reference.
`Metadata`	`getMetadata()` Gets the metadata.
`String`	`getMimeTypeName()` Gets the name of the MIME type for the reference.
`String`	`getOrigReference()` Gets the original reference for the reference.
`double`	`getPercentComplete()` Gets the percentage complete status of the file transfer.
`Product`	`getProduct()` Gets the product.
`String`	`getProductId()` Gets the ID of the product.
`String`	`getProductName()` Gets the name of the product.
`String`	`getProductReceivedTime()` Gets the metadata value of the product received time.
`String`	`getProductTypeName()` Gets the product type name for the product.
`long`	`getTotalBytes()` Gets the total bytes of the file being transferred.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TransferResource
```
public TransferResource()
```
    Default constructor required by JAXB.
  - TransferResource
```
public TransferResource(Product product,
                Metadata metadata,
                FileTransferStatus status)
```
    Constructor that sets the FileTransferStatus for the resource.
    
    Parameters:
    product - the product being transferred
    metadata - the metadata for the product being transferred
    status - the file transfer status for product
- Method Detail
  - getProduct
```
public Product getProduct()
```
    Gets the product.
    
    Returns:
    the product
  - getMetadata
```
public Metadata getMetadata()
```
    Gets the metadata.
    
    Returns:
    the metadata
  - getProductId
```
public String getProductId()
```
    Gets the ID of the product.
    
    Returns:
    the ID of the product
  - getProductName
```
public String getProductName()
```
    Gets the name of the product.
    
    Returns:
    the name of the product
  - getProductTypeName
```
public String getProductTypeName()
```
    Gets the product type name for the product.
    
    Returns:
    the product type name for the product
  - getDataStoreReference
```
public String getDataStoreReference()
```
    Gets the data store reference for the reference.
    
    Returns:
    the data store reference for the reference
  - getOrigReference
```
public String getOrigReference()
```
    Gets the original reference for the reference.
    
    Returns:
    the original reference for the reference
  - getMimeTypeName
```
public String getMimeTypeName()
```
    Gets the name of the MIME type for the reference.
    
    Returns:
    the name of the MIME type for the reference
  - getFileSize
```
public long getFileSize()
```
    Gets the file size for the reference.
    
    Returns:
    the file size for the reference
  - getTotalBytes
```
public long getTotalBytes()
```
    Gets the total bytes of the file being transferred.
    
    Returns:
    the total bytes of the file
  - getBytesTransferred
```
public long getBytesTransferred()
```
    Gets the bytes transferred status of the file transfer.
    
    Returns:
    the bytes transferred status
  - getPercentComplete
```
public double getPercentComplete()
```
    Gets the percentage complete status of the file transfer.
    
    Returns:
    the percentage complete status of the file transfer
  - getProductReceivedTime
```
public String getProductReceivedTime()
```
    Gets the metadata value of the product received time.
    
    Returns:
    the metadata value of the product received time

Class TransferResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransferResource

TransferResource

Method Detail

getProduct

getMetadata

getProductId

getProductName

getProductTypeName

getDataStoreReference

getOrigReference

getMimeTypeName

getFileSize

getTotalBytes

getBytesTransferred

getPercentComplete

getProductReceivedTime