com.filenet.wcm.toolkit.server.util
Class EProcessGranteeUtil

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.util.EProcessGranteeUtil
All Implemented Interfaces:
WcmModuleInterface

public class EProcessGranteeUtil
extends WcmModule

Utility class to support querying participants


Field Summary
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
EProcessGranteeUtil()
           
 
Method Summary
 void cleanup()
          Cleans up cached data.
 org.w3c.dom.Document fetchNextPage(int maxBufferSize)
          Returns the next page of users or groups.
 org.w3c.dom.Document fetchSecurityDomains(boolean refresh)
          Fetches for the security domain list.
 org.w3c.dom.Document findGroups(java.lang.String searchPattern, int searchType, int maxBufferSize)
          Returns the groups xml based on the query parameters.
 org.w3c.dom.Document findGroups(java.lang.String domainId, java.lang.String searchPattern, int searchType, int maxBufferSize)
          Returns the groups xml based on the query parameters.
 org.w3c.dom.Document findUsers(java.lang.String searchPattern, int searchType, int maxBufferSize)
          Returns the users xml based on the query parameters.
 org.w3c.dom.Document findUsers(java.lang.String domainId, java.lang.String searchPattern, int searchType, int maxBufferSize)
          Returns the users xml based on the query parameters.
 boolean hasNext()
          Returns true if the search result has more data.
 void initialize()
          Initializes the class data.
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
addChild, addChild, addChild, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
addDataProvider, addDataProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
addDataProvider
 

Constructor Detail

EProcessGranteeUtil

public EProcessGranteeUtil()
                    throws java.lang.Exception
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the class data.

Specified by:
initialize in interface WcmModuleInterface
Overrides:
initialize in class WcmModule
Throws:
java.lang.Exception - If there are problems.

fetchSecurityDomains

public org.w3c.dom.Document fetchSecurityDomains(boolean refresh)
                                          throws java.lang.Exception
Fetches for the security domain list.

Returns:
VWSecurityDomain A list of security domains.
Throws:
java.lang.Exception - If there are problems retrieving data.

findUsers

public org.w3c.dom.Document findUsers(java.lang.String searchPattern,
                                      int searchType,
                                      int maxBufferSize)
                               throws java.lang.Exception
Returns the users xml based on the query parameters.

Parameters:
searchPattern - String The value to query.
searchType - int The query criteria (STARTS WITH, CONTAINS, or ENDS WITH)
maxBufferSize - int The total item to be returned.
Returns:
Document The users or groups xml.
Throws:
java.lang.Exception - All Exceptions.

findUsers

public org.w3c.dom.Document findUsers(java.lang.String domainId,
                                      java.lang.String searchPattern,
                                      int searchType,
                                      int maxBufferSize)
                               throws java.lang.Exception
Returns the users xml based on the query parameters.

Parameters:
domainId - Stirng The domainId.
searchPattern - String The value to query.
searchType - int The query criteria (STARTS WITH, CONTAINS, or ENDS WITH)
maxBufferSize - int The total item to be returned.
Returns:
Document The users or groups xml.
Throws:
java.lang.Exception - All Exceptions.

findGroups

public org.w3c.dom.Document findGroups(java.lang.String searchPattern,
                                       int searchType,
                                       int maxBufferSize)
                                throws java.lang.Exception
Returns the groups xml based on the query parameters.

Parameters:
searchPattern - String The value to query.
searchType - int The query criteria (STARTS WITH, CONTAINS, or ENDS WITH)
maxBufferSize - int The total item to be returned.
Returns:
Document The users or groups xml.
Throws:
java.lang.Exception - All Exceptions.

findGroups

public org.w3c.dom.Document findGroups(java.lang.String domainId,
                                       java.lang.String searchPattern,
                                       int searchType,
                                       int maxBufferSize)
                                throws java.lang.Exception
Returns the groups xml based on the query parameters.

Parameters:
domainId - Stirng The domainId.
searchPattern - String The value to query.
searchType - int The query criteria (STARTS WITH, CONTAINS, or ENDS WITH)
maxBufferSize - int The total item to be returned.
Returns:
Document The users or groups xml.
Throws:
java.lang.Exception - All Exceptions.

fetchNextPage

public org.w3c.dom.Document fetchNextPage(int maxBufferSize)
                                   throws java.lang.Exception
Returns the next page of users or groups.

Parameters:
maxBufferSize - int The total item to be returned.
Returns:
NodeList The users or groups xml.
Throws:
java.lang.Exception - All Exceptions.

hasNext

public boolean hasNext()
                throws java.lang.Exception
Returns true if the search result has more data.

Throws:
java.lang.Exception - All Exceptions.

cleanup

public void cleanup()
             throws java.lang.Exception
Cleans up cached data.

Specified by:
cleanup in interface WcmModuleInterface
Overrides:
cleanup in class WcmModule
Throws:
java.lang.Exception


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.