com.plumtree.portalpages.admin.editors.profilesource
Class ProfileSourceModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.admin.editors.profilesource.ProfileSourceModel

All Implemented Interfaces:

IProfileSourceModelRO, IDescriptionModelRO, IMigrationModelRO, IObjEditorModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

Direct Known Subclasses:

RemoteProfileSourceModel

public abstract class ProfileSourceModel
extends ObjEditorModel
implements IProfileSourceModelRO

Version:

$Revision$

Author:

$author$

Field Summary

protected java.lang.Object[][]	m_arrOriginalPropMapInfo
protected java.lang.Object[][]	m_arrPropMapInfo Member variable for the property map information
protected java.lang.String[][]	m_asAuthPartners Member variable for the Auth Partners list
protected int	m_nPartnerID Member variable for the partner ID
protected java.lang.String	m_sProviderCLSID Member variable for the Provider CLSID
protected java.lang.String	m_strUniqueKeyPropertyName Member variable for the selected property's name
protected java.lang.String	m_sUniqueKeyTreePickerSpaceID Member variable for tree picker space ID
static int	MAPLIST_NUMCOLUMNS The number of non-plumtree object columns in the mapping list
static int	MAPLIST_PTOBJECTPOSITION The zero-based position of the Plumtree object in the mapping list
static java.lang.String	STR_MVC_CLASS_NAME The unique identifier for the class

Fields inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel

EDITOR_CLASSID_UNKNOWN, EDITOR_FOLDERID_UNKNOWN, EDITOR_OBJECTID_UNKNOWN, EDITOR_QS_BOL_QS_FORCESAVEINFOLDER, EDITOR_QS_INT_CLASS_ID, EDITOR_QS_INT_QS_FOLDER_ID, EDITOR_QS_INT_QS_OBJECT_ID, m_bDisableDescription, m_bDisableSecurity, m_bForceSavedInSuppliedFolder, m_bIsSysAdmin, m_nClassID, m_nFolderID, m_nFolderType, m_nObjectID, m_ptObject, m_Session, m_sFolderName, OBJECT_NAME_TRUNCATE

Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorModel

isReadAccessAvailable, m_asOwner, m_bCloseOnDone, m_bDeleteOnCancel, m_bEnableApplyButton, m_bEnableCancelButton, m_bHideLeftNav, m_bIsEditorReadOnly, m_bUserHasAccessToEditor, m_nEditorType

Constructor Summary

ProfileSourceModel()

Method Summary

void	ClearHistory() Repost action for clearing the history
void	DoTaskAfterStore() Code executed after the object is stored.
void	DoTaskBeforeStore() Code executed before the object is stored.
void	DoTaskOnComeBackFromSubEditor() This method will be called when you come back to the main Editor from a sub Editor.
void	DoTaskOnStartEditor(XPHashtable _htFormData) Code executed when the Editor is starting.
protected static void	Error(java.lang.String sMethod, java.lang.Exception e, java.lang.String sMessage) Method Error.
java.lang.String[][]	GetPartnerList() Returns the partner list
abstract java.lang.Object[][]	GetPartnerQueryFilter() Method for retrieving the partner query method
abstract java.lang.String	GetPropertyMapInstructions()
java.lang.String	GetPropName(int nPropID) Helper to lookup the property name given a property ID.
abstract java.lang.String	GetProviderCLSID() Returns the ProviderCLSID
int	GetSelectedPartner() Returns the selected partner id
int	GetUniqueKey() Returns the unique key (property ID) that will be sent to the providers during a profile sync.
java.lang.String	GetUniqueKeyPickerSpaceID() Returns the unique key picker space ID.
java.lang.String	GetUniqueKeyPropertyName() If a real property is selected, return the name of the property for easy viewing...
java.lang.String	GetUserProperties() Returns a comma-delimited list of property IDs that are mapped to the user object.
static java.lang.String	GetUserProperties(IPTSession ptSession)
protected void	InitAuthPartners() Method InitAuthPartners.
abstract boolean	IsPartnerMandatory() Returns true if the partner is mandatory
abstract boolean	IsPartnerSupported() Returns true if Partner is supported
protected void	PopulateSelectPTObject(java.lang.Object[] aoGroups) Populates the Group Select PTObject with data
protected boolean	PropertyMapHasChanged() Does a simple match of the original prop map info vs.
protected int	SaveMainPage(XPHashtable _htFormData) Saves the main page - auth partners, group/user selection and unique key chooser.
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
protected int	SavePropMapPage(XPHashtable _htFormData) Saves the data on the property map page.
void	SetSelectedPartner(int nID) Sets the selected partner
void	SetUniqueKey(int nUniqueKey)
void	StartPropMapList() Initializes the multi-column list for mapping properties
protected void	StartSelectPTObject() Helper method to start the Select PTObject List.

Methods inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel

CheckEditorAccess, CheckEditorAccessAndStart, CheckFolderType, DisableSecurity, Finish, ForceSaveInFolder, GetClassID, GetFolderID, GetFolderName, GetIsSysAdmin, GetMigrationStatus, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession, Init, InitIsSysAdminFlag, InitPTObject, IsDescriptionDisabled, IsMigrationApproved, SaveMigrationStatus, SetDisableDescription, SetEditorToReadOnly, SetMemberVariablesFromQS, SetMigrationStatus, StartKeywords, StartLocNamesList, StartMigrationHistory, StartObjectProp, StartSecurityList, StoreObject

Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorModel

Cancel, CleanupAllData, CleanupTempData, Create, DoTaskOnChangePage, GetAccessToEditorPriviledges, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly, GetName, GetRedirectAfterFinish, GetUserHasAccessToEditor, SetCloseOnDone, SetDeleteOnCancel, SetEditorType, SetEnableApplyButton, SetHideLeftNav, SetPageStatus, SetUserHasAccessToEditor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.plumtree.portaluiinfrastructure.editor.IObjEditorModelRO

GetClassID, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession

Methods inherited from interface com.plumtree.uiinfrastructure.editor.IEditorModelRO

GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject

GetName

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

The unique identifier for the class

See Also:

Constant Field Values

MAPLIST_NUMCOLUMNS

public static final int MAPLIST_NUMCOLUMNS

The number of non-plumtree object columns in the mapping list

See Also:

Constant Field Values

MAPLIST_PTOBJECTPOSITION

public static final int MAPLIST_PTOBJECTPOSITION

The zero-based position of the Plumtree object in the mapping list

See Also:

Constant Field Values

m_sProviderCLSID

protected java.lang.String m_sProviderCLSID

Member variable for the Provider CLSID

m_arrPropMapInfo

protected java.lang.Object[][] m_arrPropMapInfo

Member variable for the property map information

m_arrOriginalPropMapInfo

protected java.lang.Object[][] m_arrOriginalPropMapInfo

m_asAuthPartners

protected java.lang.String[][] m_asAuthPartners

Member variable for the Auth Partners list

m_nPartnerID

protected int m_nPartnerID

Member variable for the partner ID

m_sUniqueKeyTreePickerSpaceID

protected java.lang.String m_sUniqueKeyTreePickerSpaceID

Member variable for tree picker space ID

m_strUniqueKeyPropertyName

protected java.lang.String m_strUniqueKeyPropertyName

Member variable for the selected property's name

Constructor Detail

ProfileSourceModel

public ProfileSourceModel()

Method Detail

GetPartnerQueryFilter

public abstract java.lang.Object[][] GetPartnerQueryFilter()

Method for retrieving the partner query method

Specified by:

GetPartnerQueryFilter in interface IProfileSourceModelRO

Returns:

GetProviderCLSID

public abstract java.lang.String GetProviderCLSID()

Returns the ProviderCLSID

Specified by:

GetProviderCLSID in interface IProfileSourceModelRO

Returns:

String

IsPartnerMandatory

public abstract boolean IsPartnerMandatory()

Returns true if the partner is mandatory

Returns:

IsPartnerSupported

public abstract boolean IsPartnerSupported()

Returns true if Partner is supported

Specified by:

IsPartnerSupported in interface IProfileSourceModelRO

Returns:

DoTaskAfterStore

public void DoTaskAfterStore()

Code executed after the object is stored.

Overrides:

DoTaskAfterStore in class EditorModel

DoTaskBeforeStore

public void DoTaskBeforeStore()

Code executed before the object is stored.

Overrides:

DoTaskBeforeStore in class EditorModel

Throws:

XPException

PropertyMapHasChanged

protected boolean PropertyMapHasChanged()

Does a simple match of the original prop map info vs. the new one. If it differs, we return true...

Returns:

- true if the propmap has changed, false otherwise...

DoTaskOnComeBackFromSubEditor

public void DoTaskOnComeBackFromSubEditor()

This method will be called when you come back to the main Editor from a sub Editor.

Overrides:

DoTaskOnComeBackFromSubEditor in class ObjEditorModel

DoTaskOnStartEditor

public void DoTaskOnStartEditor(XPHashtable _htFormData)

Code executed when the Editor is starting.

Overrides:

DoTaskOnStartEditor in class EditorModel

Parameters:

_htFormData -

ClearHistory

public void ClearHistory()

Repost action for clearing the history

GetPartnerList

public java.lang.String[][] GetPartnerList()

Returns the partner list

Specified by:

GetPartnerList in interface IProfileSourceModelRO

Returns:

String[][]

GetSelectedPartner

public int GetSelectedPartner()

Returns the selected partner id

Specified by:

GetSelectedPartner in interface IProfileSourceModelRO

Returns:

int

SavePage

public int SavePage(java.lang.String _sPageName,
                    XPHashtable _htFormData)

Calls the right save function according to the page name passed in argument.

Specified by:

SavePage in interface IRepostModel

Overrides:

SavePage in class ObjEditorModel

Parameters:

_sPageName -

_htFormData -

Returns:

int Page status for server side validation

SaveMainPage

protected int SaveMainPage(XPHashtable _htFormData)

Saves the main page - auth partners, group/user selection and unique key chooser.

Parameters:

_htFormData -

SetSelectedPartner

public void SetSelectedPartner(int nID)

Sets the selected partner

Parameters:

nID - The ID for the selected partner

GetUserProperties

public static java.lang.String GetUserProperties(IPTSession ptSession)

StartPropMapList

public void StartPropMapList()

Initializes the multi-column list for mapping properties

Error

protected static void Error(java.lang.String sMethod,
                            java.lang.Exception e,
                            java.lang.String sMessage)

Method Error.

Parameters:

e -

sMethod -

sMessage - "ptmsgs_portaladminmsgs")

Throws:

XPException

InitAuthPartners

protected void InitAuthPartners()

Method InitAuthPartners.

PopulateSelectPTObject

protected void PopulateSelectPTObject(java.lang.Object[] aoGroups)

Populates the Group Select PTObject with data

Parameters:

aoGroups - Object[]

SavePropMapPage

protected int SavePropMapPage(XPHashtable _htFormData)

Saves the data on the property map page.

Parameters:

_htFormData -

Returns:

int Page status for server side validation

Throws:

XPException

StartSelectPTObject

protected void StartSelectPTObject()

Helper method to start the Select PTObject List.

GetPropertyMapInstructions

public abstract java.lang.String GetPropertyMapInstructions()

Specified by:

GetPropertyMapInstructions in interface IProfileSourceModelRO

Returns:

GetUniqueKey

public int GetUniqueKey()

Description copied from interface: IProfileSourceModelRO

Returns the unique key (property ID) that will be sent to the providers during a profile sync. If the unique key returned is <0, It should be checked against the PT_PROFILE_UNIQUE_KEYS enum.

Specified by:

GetUniqueKey in interface IProfileSourceModelRO

Returns:

the unique key prop id

SetUniqueKey

public void SetUniqueKey(int nUniqueKey)

GetUniqueKeyPropertyName

public java.lang.String GetUniqueKeyPropertyName()

Description copied from interface: IProfileSourceModelRO

If a real property is selected, return the name of the property for easy viewing...

Specified by:

GetUniqueKeyPropertyName in interface IProfileSourceModelRO

Returns:

the name of the property...

GetUserProperties

public java.lang.String GetUserProperties()

Description copied from interface: IProfileSourceModelRO

Returns a comma-delimited list of property IDs that are mapped to the user object.

Specified by:

GetUserProperties in interface IProfileSourceModelRO

GetPropName

public java.lang.String GetPropName(int nPropID)

Helper to lookup the property name given a property ID. Will only match properties that are properly mapped to the user object.

Parameters:

nPropID - - property id to resolve

Returns:

a String that represents the name of the property. empty-String if the property doesn't exist or is not mapped to the user object.

GetUniqueKeyPickerSpaceID

public java.lang.String GetUniqueKeyPickerSpaceID()

Description copied from interface: IProfileSourceModelRO

Returns the unique key picker space ID. This is used to track tree picker instances so that if you click the button to pick a group twice, you get the same tree.

Specified by:

GetUniqueKeyPickerSpaceID in interface IProfileSourceModelRO

Returns:

the unique key picker space id