com.ibm.ccd.ui.mediator
Interface IWPCMediator

All Known Implementing Classes:
WPCMediator

public interface IWPCMediator

Represents the business functions available on the WPC. Provides the summary of the soap-calls supported by the mediator. Note: Most of the calls treats the Async. Process as the Application error and throws the WPCMediatorExcpetion setting APPError with the notificationBean.


Method Summary
 java.lang.String createItem(ICatalogItem item, WPSContext context)
          creates the item in WPC,the default invokation mode is Sync.
 void deleteItem(ICatalogItem item, WPSContext context)
          deletes the item in WPC, the default invokation mode is Sync.
 void deleteItem(java.lang.String parentCgy, java.lang.String catalogID, java.lang.String itemID, WPSContext context)
          deletes the Item from WPC for the given itemID, catalogID and ParenetCategory ID The default invokation mode is Sync.
 java.lang.String downloadItemDetails(CategoryHierarchy hierarchy, ICatalogItem catalogItem, java.lang.String[] headerInfor, java.lang.String[] itemPrimaryKey, WPSContext context)
          This Method is for downloading Item(s) from SingleItem or from Search results
 java.util.List getBusinessProcess(WPSContext context)
           
 java.util.List getBusinessProcess(WPSContext context, java.lang.String roleName)
           
 Node[] getCatalogChildren(java.lang.String parentCategory, java.lang.String catalogName, java.lang.String hierarchyName, java.lang.String heirarchyType, java.lang.String childrenSize, WPSContext context)
          returns the children of the catalog node for a particular parent category, Hierarychy, Catalog
 Node[] getCatalogChildren(java.lang.String parentID, WPSContext context)
          returns the children of the catalog node, the default invokation mode is Sync.
 ICatalogItem getCatalogItem(java.lang.String parentCgyID, java.lang.String catalogID, java.lang.String itemID, WPSContext context)
          returns the catalog item from WPC for the given catalogID and parent CategoryID, the default invokation mode is Sync.
 ICatalogItem getCatalogItem(java.lang.String parentCgyID, java.lang.String catalogID, WPSContext context)
          returns the catalog Spec.
 ICatalogItem getCatalogItemClone(ICatalogItem item, WPSContext context)
          Returns Clone of the CatalogItem for the given item
 ICatalogItem getCatalogItemClone(java.lang.String parentCgyID, java.lang.String catalogID, java.lang.String itemID, WPSContext context)
          Returns Clone of the CatalogItem for the given itemID,catalogID and parentCategory
 CategoryHierarchy[] getCatalogs(WPSContext context)
          returns the first level of Hierarychy for the Catalogs
 CatalogViewMaster getCatalogView(java.lang.String catalogName, java.lang.String catalogViewName, WPSContext context)
           
 java.util.List getCatalogViewList(java.lang.String catalogName, WPSContext context)
          returs a list of CatalogViews for a given CatalogName
 java.lang.String getDefaultCatalog()
          This utility method has to be retained in the WPC Mediator.
 java.lang.Object getImageObject(FileDownloadResource resourceObj, WPSContext context)
          This method fetches Image stream from wpc for specific Item (GTNID) and attribute.
 Workflow getSteps(WPSContext context, java.lang.String roleName, java.lang.String workflowName)
           
 java.util.List getTransactionsDetails(java.lang.String transactionId, WPCUser wpcUser)
          This method fetches Transaction Details primarily the attachment associated with Transaction.
 java.util.Map getTransactionsStatus(java.lang.String[] strArry, WPSContext context)
          Triggers the WPC to get the trasactions from WPC and updates Trasactions Object with new status of each transactions in ITransactions
 java.util.List getUserRoles(WPSContext context)
           
 void performSearch(SearchBean searchBean, WPSContext context)
          Triggers the WPC to Perform the search based on the criteria and prepares the result
 void processAction(WPSContext context, WorkFlowTO workflowTo)
           
 java.lang.String processUploadedFile(java.lang.String documentPath, java.lang.String collabName, WPSContext context)
          Provides the followup process action for the uplaod which triggers the for an update in wpc
 void updateItem(ICatalogItem item, WPSContext context)
          updates the item in WPC, the default invokation mode is Sync.
 java.lang.String uploadFile(Attachment attachment, WPSContext context)
          uploads the file into WPC, and returns with the doc.path The default invokation mode is ASync.
 

Method Detail

getCatalogs

CategoryHierarchy[] getCatalogs(WPSContext context)
                                throws WPCMediatorException
returns the first level of Hierarychy for the Catalogs

Parameters:
context -
Returns:
CategoryHeirarychy - array of hierarychy names and which catalog it belongs
Throws:
WPCMediatorException - in case of retrieval

getCatalogChildren

Node[] getCatalogChildren(java.lang.String parentID,
                          WPSContext context)
                          throws WPCMediatorException
returns the children of the catalog node, the default invokation mode is Sync.

Parameters:
parentID - - parentNode ID of type String
Returns:
Node[] - representing the catalog node's first level children.
Throws:
WPCMediatorException - in case of retrieval errors

getCatalogChildren

Node[] getCatalogChildren(java.lang.String parentCategory,
                          java.lang.String catalogName,
                          java.lang.String hierarchyName,
                          java.lang.String heirarchyType,
                          java.lang.String childrenSize,
                          WPSContext context)
                          throws WPCMediatorException
returns the children of the catalog node for a particular parent category, Hierarychy, Catalog

Parameters:
parentCategory -
catalogName -
hierarchyName -
heirarchyType -
context -
Returns:
Node[] - representing the catalog node's first level children
Throws:
WPCMediatorException

getCatalogItem

ICatalogItem getCatalogItem(java.lang.String parentCgyID,
                            java.lang.String catalogID,
                            WPSContext context)
                            throws WPCMediatorException
returns the catalog Spec. from WPC for the given catalogID and parent CategoryID , the default invokation mode is Sync.

Parameters:
parentCgyID - - Parent CategoryID of the catalog
catalogID - - category ID of the catalog
Returns:
ICatalogItem - representing the catalogSpec.
Throws:
WPCMediatorException - in case of retrieval errors

getCatalogItem

ICatalogItem getCatalogItem(java.lang.String parentCgyID,
                            java.lang.String catalogID,
                            java.lang.String itemID,
                            WPSContext context)
                            throws WPCMediatorException
returns the catalog item from WPC for the given catalogID and parent CategoryID, the default invokation mode is Sync.

Parameters:
parentCgyID - - Parent CategoryID of the catalog
catalogID - - category ID of the catalog
itemID - - itemID (primaryKey)
Returns:
ICatalogItem
Throws:
WPCMediatorException - in case of retrieval errors

getCatalogViewList

java.util.List getCatalogViewList(java.lang.String catalogName,
                                  WPSContext context)
                                  throws WPCMediatorException
returs a list of CatalogViews for a given CatalogName

Parameters:
catalogName -
context -
Returns:
list
Throws:
WPCMediatorException

getCatalogView

CatalogViewMaster getCatalogView(java.lang.String catalogName,
                                 java.lang.String catalogViewName,
                                 WPSContext context)
                                 throws WPCMediatorException
Parameters:
catalogName -
catalogViewName -
context -
Returns:
catalogViewMaster
Throws:
WPCMediatorException

createItem

java.lang.String createItem(ICatalogItem item,
                            WPSContext context)
                            throws WPCMediatorException
creates the item in WPC,the default invokation mode is Sync.

Parameters:
item - - of type ICatalogItem representing the item to create
Returns:
ItemID created(primarykey)
Throws:
WPCMediatorException - in case of creation errors/async. process

updateItem

void updateItem(ICatalogItem item,
                WPSContext context)
                throws WPCMediatorException
updates the item in WPC, the default invokation mode is Sync.

Parameters:
item - - of type ICatalogItem representing the item to create
Throws:
WPCMediatorException - in case of updation errors/ async. process.

deleteItem

void deleteItem(ICatalogItem item,
                WPSContext context)
                throws WPCMediatorException
deletes the item in WPC, the default invokation mode is Sync.

Parameters:
item - - of type ICatalogItem representing the item to create
Throws:
WPCMediatorException - in case of updation errors/ async. process.

deleteItem

void deleteItem(java.lang.String parentCgy,
                java.lang.String catalogID,
                java.lang.String itemID,
                WPSContext context)
                throws WPCMediatorException
deletes the Item from WPC for the given itemID, catalogID and ParenetCategory ID The default invokation mode is Sync.

Parameters:
parentCgy -
catalogID - - category ID of the catalog
itemID - - itemID (primaryKey)
Throws:
WPCMediatorException - in case of updation errors/ async. process.

getCatalogItemClone

ICatalogItem getCatalogItemClone(java.lang.String parentCgyID,
                                 java.lang.String catalogID,
                                 java.lang.String itemID,
                                 WPSContext context)
                                 throws WPCMediatorException
Returns Clone of the CatalogItem for the given itemID,catalogID and parentCategory

Throws:
WPCMediatorException

getCatalogItemClone

ICatalogItem getCatalogItemClone(ICatalogItem item,
                                 WPSContext context)
                                 throws WPCMediatorException
Returns Clone of the CatalogItem for the given item

Throws:
WPCMediatorException

uploadFile

java.lang.String uploadFile(Attachment attachment,
                            WPSContext context)
                            throws WPCMediatorException
uploads the file into WPC, and returns with the doc.path The default invokation mode is ASync.

Parameters:
attachment - - file to upload as an Attachment type
Returns:
document path where the file has been uploaded. of type String
Throws:
WPCMediatorException - in case of updation errors/ async. process.
See Also:
Attachment

processUploadedFile

java.lang.String processUploadedFile(java.lang.String documentPath,
                                     java.lang.String collabName,
                                     WPSContext context)
                                     throws WPCMediatorException
Provides the followup process action for the uplaod which triggers the for an update in wpc

Parameters:
documentPath - - path to the file to be updated in the WPC
Returns:
transaction ID.
Throws:
WPCMediatorException - in case of updation errors/ async. process.

performSearch

void performSearch(SearchBean searchBean,
                   WPSContext context)
                   throws WPCMediatorException
Triggers the WPC to Perform the search based on the criteria and prepares the result

Parameters:
searchBean - - provides the searchcritera and filled with the search results
Throws:
WPCMediatorException - in case of updation errors/ async. process.

getTransactionsStatus

java.util.Map getTransactionsStatus(java.lang.String[] strArry,
                                    WPSContext context)
                                    throws WPCMediatorException
Triggers the WPC to get the trasactions from WPC and updates Trasactions Object with new status of each transactions in ITransactions

Parameters:
strArry -
context -
Throws:
WPCMediatorException - in case of updation errors/ async. process.

getTransactionsDetails

java.util.List getTransactionsDetails(java.lang.String transactionId,
                                      WPCUser wpcUser)
                                      throws WPCMediatorException
This method fetches Transaction Details primarily the attachment associated with Transaction. List will contain collection of attachment.Attachment is returned as a inputstream.

Parameters:
transactionId -
wpcUser -
Returns:
list
Throws:
WPCMediatorException

getDefaultCatalog

java.lang.String getDefaultCatalog()
This utility method has to be retained in the WPC Mediator. Currently there is only one catalog which needs to be pre-configured for deployment at a client-site. This method and a whole slew of functionality can be created in the Mediator to return the current catalog that a user needs to work with, in the case that there are multiple catalogs to be deployed at a client-site

Returns:
String representing the Catalog ID. For example, "CTG_PORTAL_MASTER"

getImageObject

java.lang.Object getImageObject(FileDownloadResource resourceObj,
                                WPSContext context)
                                throws WPCMediatorException
This method fetches Image stream from wpc for specific Item (GTNID) and attribute.

Parameters:
resourceObj -
context -
Returns:
object
Throws:
WPCMediatorException

downloadItemDetails

java.lang.String downloadItemDetails(CategoryHierarchy hierarchy,
                                     ICatalogItem catalogItem,
                                     java.lang.String[] headerInfor,
                                     java.lang.String[] itemPrimaryKey,
                                     WPSContext context)
                                     throws WPCMediatorException
This Method is for downloading Item(s) from SingleItem or from Search results

Parameters:
hierarchy -
catalogItem -
headerInfor -
itemPrimaryKey -
Returns:
string
Throws:
WPCMediatorException

getUserRoles

java.util.List getUserRoles(WPSContext context)
                            throws WPCMediatorException
Parameters:
context -
Returns:
list
Throws:
WPCMediatorException

getBusinessProcess

java.util.List getBusinessProcess(WPSContext context)
                                  throws WPCMediatorException
Parameters:
context -
Returns:
list
Throws:
WPCMediatorException

getBusinessProcess

java.util.List getBusinessProcess(WPSContext context,
                                  java.lang.String roleName)
                                  throws WPCMediatorException
Parameters:
context -
roleName -
Returns:
list
Throws:
WPCMediatorException

getSteps

Workflow getSteps(WPSContext context,
                  java.lang.String roleName,
                  java.lang.String workflowName)
                  throws WPCMediatorException
Parameters:
context -
roleName -
workflowName -
Returns:
worklfow
Throws:
WPCMediatorException

processAction

void processAction(WPSContext context,
                   WorkFlowTO workflowTo)
                   throws WPCMediatorException
Parameters:
context -
workflowTo -
Throws:
WPCMediatorException