com.ibm.ccd.portal
Class PortalCollaborationHelper

java.lang.Object
  extended by com.ibm.ccd.portal.PortalCollaborationHelper
All Implemented Interfaces:
WPCPortalCollaborationHelper

public class PortalCollaborationHelper
extends java.lang.Object
implements WPCPortalCollaborationHelper


Constructor Summary
PortalCollaborationHelper()
           
 
Method Summary
 java.lang.String constructResponseForCollabAreaDetails(java.util.HashMap infoMap)
          Builds the collaboration area details accessible by a specific role the details include the information about the collaboration area workflow and of each step accessible by the current role
 java.lang.String constructResponseForCollabAreaList(java.util.HashMap infoMap)
          Builds the collaboration area list for a role if the role section is populated else for the current user if the role section is blank.and returns the list of collaboration areas in XML format.The role is specified in the header that is passed along .
 java.lang.String constructResponseForCollaborationAreaAction(java.util.HashMap infoMap)
          Performs one of the following collArea actions Move entries to next step Reserve entries in next step Release entries in step
 java.lang.String constructResponseForItemsInCollabAreaStep(java.util.HashMap infoMap)
          Returns xml representation of workflow step entries for the given Collaboration step based on a specific attribute value.
 java.lang.String constructResponseForSearchCollAreaStepItems(java.util.HashMap infoMap)
          Builds xml representation of workflow step entries for the given Collaboration step based on a specific search criteria.All the required details required to fetch the information are fetched from the header passed along .
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortalCollaborationHelper

public PortalCollaborationHelper()
Method Detail

constructResponseForCollabAreaList

public java.lang.String constructResponseForCollabAreaList(java.util.HashMap infoMap)
                                                    throws com.ibm.pim.common.exceptions.PIMException,
                                                           com.ibm.pim.common.exceptions.PIMInternalException,
                                                           java.lang.IllegalArgumentException
Description copied from interface: WPCPortalCollaborationHelper
Builds the collaboration area list for a role if the role section is populated else for the current user if the role section is blank.and returns the list of collaboration areas in XML format.The role is specified in the header that is passed along .

Specified by:
constructResponseForCollabAreaList in interface WPCPortalCollaborationHelper
Parameters:
infoMap - contains the header information
Returns:
the returns the list of collaboration areas in XML format
Throws:
com.ibm.pim.common.exceptions.PIMException
com.ibm.pim.common.exceptions.PIMInternalException
java.lang.IllegalArgumentException

constructResponseForCollaborationAreaAction

public java.lang.String constructResponseForCollaborationAreaAction(java.util.HashMap infoMap)
                                                             throws com.ibm.pim.common.exceptions.PIMException
Description copied from interface: WPCPortalCollaborationHelper
Performs one of the following collArea actions Move entries to next step Reserve entries in next step Release entries in step

Specified by:
constructResponseForCollaborationAreaAction in interface WPCPortalCollaborationHelper
Parameters:
infoMap - hashmap containing the header information
Throws:
com.ibm.pim.common.exceptions.PIMException

constructResponseForCollabAreaDetails

public java.lang.String constructResponseForCollabAreaDetails(java.util.HashMap infoMap)
                                                       throws com.ibm.pim.common.exceptions.PIMException,
                                                              com.ibm.pim.common.exceptions.PIMInternalException,
                                                              java.lang.IllegalArgumentException
Description copied from interface: WPCPortalCollaborationHelper
Builds the collaboration area details accessible by a specific role the details include the information about the collaboration area workflow and of each step accessible by the current role

Specified by:
constructResponseForCollabAreaDetails in interface WPCPortalCollaborationHelper
Parameters:
infoMap - infoMap containing header information
Returns:
the string containing the details in the xml format
Throws:
com.ibm.pim.common.exceptions.PIMException
com.ibm.pim.common.exceptions.PIMInternalException
java.lang.IllegalArgumentException

constructResponseForSearchCollAreaStepItems

public java.lang.String constructResponseForSearchCollAreaStepItems(java.util.HashMap infoMap)
                                                             throws com.ibm.pim.common.exceptions.PIMException,
                                                                    com.ibm.pim.common.exceptions.PIMInternalException,
                                                                    java.lang.IllegalArgumentException
Description copied from interface: WPCPortalCollaborationHelper
Builds xml representation of workflow step entries for the given Collaboration step based on a specific search criteria.All the required details required to fetch the information are fetched from the header passed along .

Specified by:
constructResponseForSearchCollAreaStepItems in interface WPCPortalCollaborationHelper
Returns:
string containing the xml representation of the information obtained.
Throws:
com.ibm.pim.common.exceptions.PIMException
com.ibm.pim.common.exceptions.PIMInternalException
java.lang.IllegalArgumentException

constructResponseForItemsInCollabAreaStep

public java.lang.String constructResponseForItemsInCollabAreaStep(java.util.HashMap infoMap)
                                                           throws com.ibm.pim.common.exceptions.PIMException,
                                                                  com.ibm.pim.common.exceptions.PIMInternalException,
                                                                  java.lang.IllegalArgumentException
Description copied from interface: WPCPortalCollaborationHelper
Returns xml representation of workflow step entries for the given Collaboration step based on a specific attribute value. all the required details required to fetch the information are fetched from the header passed along .

Specified by:
constructResponseForItemsInCollabAreaStep in interface WPCPortalCollaborationHelper
Parameters:
infoMap - hashmap containing the neccessary header information.
Returns:
string containing the xml representation of the information obtained.
Throws:
com.ibm.pim.common.exceptions.PIMException
com.ibm.pim.common.exceptions.PIMInternalException
java.lang.IllegalArgumentException