|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTProfileSource
Profile source objects import user profile information from external repositories.
com.plumtree.server.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. |
int |
GetPortalUniqueKey()
Returns the id of an IPTProperty or a value from the
PT_PROFILE_UNIQUE_KEYS enumeration. |
java.lang.Object[][] |
GetPropertyMap()
Returns the map from property id to provider attribute. |
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 |
SetPortalUniqueKey(int nUniqueKeyID)
Allows a particular property value to be sent to remote profile providers (PWS) in place of the portal's unique name for each user. |
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. |
void |
UpdateUserProfile(int nUserID)
Updates the given user's profile against this profile source. |
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 |
Methods inherited from interface com.plumtree.server.IPTServerContext |
---|
GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject |
Methods inherited from interface com.plumtree.server.IPTStorable |
---|
Store |
Method Detail |
---|
java.lang.String GetProviderCLSID()
void SetProviderCLSID(java.lang.String Value)
Value
- a CLSIDcom.plumtree.openfoundation.util.IXPPropertyBag GetProviderInfo()
void SetProviderInfo(com.plumtree.openfoundation.util.IXPPropertyBag Value)
Value
- the provider property bagvoid SetProviderInfo(java.lang.String Value)
Value
- the provider property bag as XMLjava.lang.Object[] GetGroupList()
void SetGroupList(int[] Value)
Value
- array of group and user idsvoid SetGroupList(java.lang.Object[] Value)
Value
- array of group and user idsint GetAuthSourcePartner()
void SetAuthSourcePartner(int Value)
Value
- an auth source idjava.lang.Object[][] GetPropertyMap()
void SetPropertyMap(java.lang.Object[][] Value)
Value
- array of [property id, attribute]int GetWebServiceID()
void SetWebServiceID(int Value)
Value
- a web service idvoid ClearHistory()
void SetPortalUniqueKey(int nUniqueKeyID)
Allows a particular property value to be sent to remote profile providers (PWS) in place of the portal's unique name for each user.
nUniqueKeyID
- - the object id of an IPTProperty
you wish to
send to remote profile providers (PWS) in place of the portal's unique key.
Alternatively, one can pass something from the PT_PROFILE_UNIQUE_KEYS
enumeration.IPTProperty
,
PT_PROFILE_UNIQUE_KEYS
int GetPortalUniqueKey()
Returns the id of an IPTProperty
or a value from the
PT_PROFILE_UNIQUE_KEYS
enumeration.
IPTProperty
object id, or a PT_PROFILE_UNIQUE_KEYS
value.IPTProperty
,
PT_PROFILE_UNIQUE_KEYS
void UpdateUserProfile(int nUserID)
Updates the given user's profile against this profile source. If the user has no valid attributes in the remote profile repository, no changes will be made. This function does not replace a profile synchronization, but instead allows for singleton updates of specific users between profile syncs.
nUserID
- - the portal user id of the user to update
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |