com.ibm.ram.rich.ui.downloadasset
Class AbstractDownloadAssetContributor

java.lang.Object
  extended by com.ibm.ram.rich.ui.downloadasset.AbstractDownloadAssetContributor

public abstract class AbstractDownloadAssetContributor
extends java.lang.Object

Represents the base implementation for anyone extending the com.ibm.ram.rich.ui.extension.downloadAsset extension point to contribute importers in the UI. Extending classes can provide a name and image for their custom importers, which will be shown in UI. After a user selects this importer, further interaction occurs, culminating in the handing over of import.


Constructor Summary
AbstractDownloadAssetContributor()
           
 
Method Summary
 IAssetIdentifier[] getAssetsToImport()
          Deprecated.  
 Image getImage()
          Name of the contributor which shows up in the import wizard as the top level import contributor.
 AssetInformation[] getImportAssets()
          Returns all the assets to import which should include the user selected assets.
 java.lang.String getName()
          Name of the contributor which shows up in the import wizard as the top level import contributor.
 IWizardPage[] getWizardPages()
          Returns wizard pages to add to the import process.
 IStatus[] importAssets(java.io.InputStream[] assetInputStreams, Shell shell, IProgressMonitor monitor)
          Contributor should import the provided assets into the user selected target.
 void setSelectedAssets(Asset[] assets, java.lang.String[] serverLocations, java.lang.String[] userIDs)
          Deprecated.  
 void setSelectedAssets(AssetInformation[] assets)
          Sets all the assets which are selected by the user.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractDownloadAssetContributor

public AbstractDownloadAssetContributor()
Method Detail

getName

public java.lang.String getName()
Name of the contributor which shows up in the import wizard as the top level import contributor.

Returns:

getImage

public Image getImage()
Name of the contributor which shows up in the import wizard as the top level import contributor.

Returns:

setSelectedAssets

public void setSelectedAssets(Asset[] assets,
                              java.lang.String[] serverLocations,
                              java.lang.String[] userIDs)
Deprecated. 

Sets all the assets which are selected by the user.

Parameters:
assets - Assets to be imported
See Also:
setSelectedAssets(AssetInformation[])

setSelectedAssets

public void setSelectedAssets(AssetInformation[] assets)
Sets all the assets which are selected by the user.

Parameters:
assets - Assets to be imported

getWizardPages

public IWizardPage[] getWizardPages()
Returns wizard pages to add to the import process. They control if the import is finally called.

Parameters:
assets -
Returns:

getAssetsToImport

public IAssetIdentifier[] getAssetsToImport()
Deprecated. 

Returns all the assets to import which should include the user selected assets. Additionally they can include other assets which the contributor deems relevant. Related assets are an example of such assets.

Returns:
See Also:
getImportAssets()

getImportAssets

public AssetInformation[] getImportAssets()
Returns all the assets to import which should include the user selected assets. Additionally they can include other assets which the contributor deems relevant. Related assets are an example of such assets.

Returns:

importAssets

public IStatus[] importAssets(java.io.InputStream[] assetInputStreams,
                              Shell shell,
                              IProgressMonitor monitor)
Contributor should import the provided assets into the user selected target.

Parameters:
assetInputStreams - Streams for the assets provided by getAssetsToImport()
shell - Shell so that the importer can ask questions to the user.
monitor -