com.plumtree.server
Interface IPTProfileSource

All Superinterfaces:
IPTLocalizable, IPTObject, IPTUnknown

public interface IPTProfileSource
extends IPTObject

Profile source objects import user profile information from external repositories.

See Also:
IPTProfileSourceProvider

Method Summary
 void ClearHistory()
          Clears the history of imports, so all information will be re-imported during the next sync.
 int GetAuthSourcePartner()
          Returns the auth source parter whose settings will be used for the provider.
 java.lang.Object[] GetGroupList()
          Returns the list of groups whose profile information will be updated.
 java.lang.Object[][] GetPropertyMap()
          Returns the map from property id to provider attribute.
 IPTProfileSourceProvider GetProvider()
          Deprecated.  
 java.lang.String GetProviderCLSID()
          Returns the CLSID of the provider for this auth source.
 com.plumtree.openfoundation.util.IXPPropertyBag GetProviderInfo()
          Returns the provider property bag.
 int GetWebServiceID()
          Returns the id of the web service associated with the provider.
 void SetAuthSourcePartner(int Value)
          Sets the auth source parter whose settings will be used for the provider.
 void SetGroupList(int[] Value)
          Sets the list of groups whose profile information will be updated.
 void SetGroupList(java.lang.Object[] Value)
          Sets the list of groups whose profile information will be updated.
 void SetPropertyMap(java.lang.Object[][] Value)
          Sets the map from property id to provider attribute.
 void SetProviderCLSID(java.lang.String Value)
          Sets the provider CLSID.
 void SetProviderInfo(com.plumtree.openfoundation.util.IXPPropertyBag Value)
          Sets the provider property bag.
 void SetProviderInfo(java.lang.String Value)
          Sets the provider property bag as XML.
 void SetWebServiceID(int Value)
          Returns the id of the web service associated with the provider.
 
Methods inherited from interface com.plumtree.server.IPTObject
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified
 
Methods inherited from interface com.plumtree.server.IPTLocalizable
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

GetProviderCLSID

public java.lang.String GetProviderCLSID()
Returns the CLSID of the provider for this auth source.
Returns:
a CLSID

SetProviderCLSID

public void SetProviderCLSID(java.lang.String Value)
Sets the provider CLSID.
Parameters:
Value - a CLSID

GetProviderInfo

public com.plumtree.openfoundation.util.IXPPropertyBag GetProviderInfo()
Returns the provider property bag.
Returns:
the provider property bag

SetProviderInfo

public void SetProviderInfo(com.plumtree.openfoundation.util.IXPPropertyBag Value)
Sets the provider property bag.
Parameters:
Value - the provider property bag

SetProviderInfo

public void SetProviderInfo(java.lang.String Value)
Sets the provider property bag as XML.
Parameters:
Value - the provider property bag as XML

GetGroupList

public java.lang.Object[] GetGroupList()
Returns the list of groups whose profile information will be updated. Users can be included in the list with negative id numbers.
Returns:
array of group and user ids

SetGroupList

public void SetGroupList(int[] Value)
Sets the list of groups whose profile information will be updated. Users can be included in the list with negative id numbers.
Parameters:
Value - array of group and user ids

SetGroupList

public void SetGroupList(java.lang.Object[] Value)
Sets the list of groups whose profile information will be updated. Users can be included in the list with negative id numbers.
Parameters:
Value - array of group and user ids

GetAuthSourcePartner

public int GetAuthSourcePartner()
Returns the auth source parter whose settings will be used for the provider.
Returns:
an auth source id

SetAuthSourcePartner

public void SetAuthSourcePartner(int Value)
Sets the auth source parter whose settings will be used for the provider.
Parameters:
Value - an auth source id

GetProvider

public IPTProfileSourceProvider GetProvider()
Deprecated.  

Returns the provider.
Returns:
an IPTProfileSourceProvider

GetPropertyMap

public java.lang.Object[][] GetPropertyMap()
Returns the map from property id to provider attribute.
Returns:
array of [property id, attribute]

SetPropertyMap

public void SetPropertyMap(java.lang.Object[][] Value)
Sets the map from property id to provider attribute.
Parameters:
Value - array of [property id, attribute]

GetWebServiceID

public int GetWebServiceID()
Returns the id of the web service associated with the provider.
Returns:
a web service id

SetWebServiceID

public void SetWebServiceID(int Value)
Returns the id of the web service associated with the provider.
Parameters:
Value - a web service id

ClearHistory

public void ClearHistory()
Clears the history of imports, so all information will be re-imported during the next sync.


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.