com.sapportals.portal.pcd.gl.admin

Class PcdAdministration

java.lang.Object
  extended by com.sapportals.portal.pcd.gl.admin.PcdAdministration

public class PcdAdministration
extends Object

This factory offers some administrative methods for the PCD GL.


Constructor Summary
PcdAdministration()
           
 
Method Summary
 void clonePersonalization(String sourcePrincipalId, List targetPrincipalIds, boolean overwrite)
          Copies the personalization for the given users
 List getPersonalizedObjects(String principalId)
          Returns the list object names (in PCD namespace) which are personalized by a given principal a name
 List getPersonalizingPrincipalIds(String nameInNamespace, List principalIds)
          Returns a list of the unique principal ids which have personalized the PCD object specified by a name
 void removeObjectFromCache(String name)
          Removes the object that is bound to the given name from the PCD cache.
 void removePersonalization(List principalIds, List objectIds)
          Removes the personalization for the given objects for all given principals
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PcdAdministration

public PcdAdministration()
Method Detail

clonePersonalization

public void clonePersonalization(String sourcePrincipalId,
                                 List targetPrincipalIds,
                                 boolean overwrite)
                          throws NamingException
Copies the personalization for the given users

Parameters:
sourcePrincipalId - The id of the principals for which the personalization is to be copied. The list has to contain the unique principal ids as String.
targetPrincipalIds - The names of the principals to which the personalization is copied
Throws:
NamingException

getPersonalizedObjects

public List getPersonalizedObjects(String principalId)
                            throws NamingException
Returns the list object names (in PCD namespace) which are personalized by a given principal a name

Parameters:
principalId - The unique principal id as String
Throws:
NamingException

getPersonalizingPrincipalIds

public List getPersonalizingPrincipalIds(String nameInNamespace,
                                         List principalIds)
                                  throws NamingException
Returns a list of the unique principal ids which have personalized the PCD object specified by a name

Parameters:
nameInNamespace - The name in the PCD namespace without prefix (as instance of String)
principalIds - A list of principal ids to search for. If the parameter is null, all users will be returned. The list has to contain the unique principal ids as String.
Throws:
NamingException

removeObjectFromCache

public void removeObjectFromCache(String name)
                           throws NamingException
Removes the object that is bound to the given name from the PCD cache.

Parameters:
name - The name (as instance of String)
Throws:
NamingException

removePersonalization

public void removePersonalization(List principalIds,
                                  List objectIds)
                           throws NamingException
Removes the personalization for the given objects for all given principals

Parameters:
principalIds - The ids of the principals for which the personalization is to be removed. The list has to contain the unique principal ids as String. If the parameter is null, personalization will be removed for all principals.
objectIds - The names of the objects for which the personalization is to be removed. If the parameter is null, the personalization of all objects will be removed.
Throws:
NamingException
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-BASIS [sap.com] tc/epbc/pcd/pars/srvgldeprecated api BC-PIN-PCD


Copyright 2011 SAP AG Complete Copyright Notice