com.ibm.interfaces.portal
Interface WPCPortalCollaborationHelper

All Known Implementing Classes:
PortalCollaborationHelper

public interface WPCPortalCollaborationHelper


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 .
 

Method Detail

constructResponseForCollabAreaList

java.lang.String constructResponseForCollabAreaList(java.util.HashMap infoMap)
                                                    throws com.ibm.pim.common.exceptions.PIMException
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 .

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

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

Parameters:
infoMap - hashmap containing the header information
Throws:
com.ibm.pim.common.exceptions.PIMException

constructResponseForCollabAreaDetails

java.lang.String constructResponseForCollabAreaDetails(java.util.HashMap infoMap)
                                                       throws com.ibm.pim.common.exceptions.PIMException
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

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

java.lang.String constructResponseForSearchCollAreaStepItems(java.util.HashMap infoMap)
                                                             throws com.ibm.pim.common.exceptions.PIMException
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 .

Parameters:
infoMap -
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

java.lang.String constructResponseForItemsInCollabAreaStep(java.util.HashMap infoMap)
                                                           throws com.ibm.pim.common.exceptions.PIMException
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 .

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