CATPLMUIInterfaces Interface CATIPLMObjectSelector

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIPLMObjectSelector

This interface provides access to UI for any PLM entity selection.

This Object Selector can load a PLM entity in session or select an entity already in session.
If the caller is a CATCommand and not a CATDialog, you should call:

Example:

 
 CATCommand * pCmd = NULL;

 HRESULT hr = pObjectSelector -> StartCommand(pCmd);

 if (SUCCEEDED(hr) && CATSysCheckExpression(NULL != pCmd))

    pCmd -> SetFather();


 in order to let the caller receive the notifications.


 

See also:

, interface.
The PLM Object Selector launches a dialog panel to allow the user to retrieve a PLM entity. The user can do it through a user interface to query from the underlying database, or retrieved already loaded PLM entities from session, or select a PLM entity in any window. If the PLM entity is not already loaded, the PLM entity is loaded when the OK button of the dialog panel is pressed.
This Interface serves the following purpose:

• Criteria to be respected by candidate PLM entity

All these methods must be called BEFORE the StartCommand method is launched.

• : To specify the type of PLM Entity.
• To specify some public attribute-value pairs. If you do not call this method, no filter attribute is done. This method is not mandatory.
• Launch the command

Calling the method you activate it. The dialog box is natively visible.

• Get the notification sent by the PLM Object Selector Dialog box

All these methods can be called either after or before the StartCommand.

• : to be aware when the OK button is pressed
• to be aware when the Cancel button is pressed

Attention, in order to receive the notifications, you must previously call the SetFather method. This call must be done before adding the callbacks using the AddAnalyseNotificationCB calls

                CATIPLMObjectSelector * piPLMObjectSelector = ...
                CATCommand* pCmd = NULL;
                HRESULT Hr = piPLMObjectSelector->StartCommand(pCmd);
                if (SUCCEEDED(Hr) && pCmd)
                {
                  pCmd->SetFather(this);   // this is to let our command receive the notifications
                  ...
                  AddAnalyseNotificationCB ( pCmd, 
                                 piPLMObjectSelector->GetSelectionEndedNotification(pOKNotif)
								  ...,...);
                }
          

• Retrieve and load the selected object in session

Once the End notification is received you can retrieve the PLM entity selected by the user in the output list displayed in the PLM Object Selector panel.

Method Index

o GetSelection(CATBaseUnknown*&)

Retrieve the selected PLM Entity.

o GetSelectionCancelledNotification(CATNotification*&)

Retrieves the the Cancel notification.

o GetSelectionEndedNotification(CATNotification*&)

Retrieves the End Selection notification.

o GetVisibility(unsigned long&)

Retrieve the current display state of the dialog object.

o SetAttributesScope(CATListValCATBaseUnknown_var*&)

Defines some public attribute-value pairs.

o SetDataOrigins(CATListOfInt&)

Declare tab pages which should appear in the ObjectSelector dialog.

o SetObjectScopeFromType(CATIType_var&)

Sets the PLM Type of the PLM entity to respect.

o SetTitle(CATUnicodeString&)

Sets the NLS title of the dialog object (PLM Object Selector panel).

o SetVisibility(unsigned long)

Sets the current display state of the dialog object (PLM Object Selector panel).

o StartCommand(CATCommand*&)

Launches the PLM Object Selector command and its dialog panel.

Methods

Retrieve the selected PLM Entity.
Role:This method enables you to retrieve the selected PLM Entity.
This method can be called only once the end notification has been received(when the OK button is pressed).

In order to manage correctly the PLM Entity in session, you have to set into a bag until you don't need it.

Parameters:

oSelection

[out, CATBaseUnknown#Release] The selected PLM Entity. The pointer must be released.

Returns:

• S_OK if succeeded
• E_FAIL otherwise

Retrieves the the Cancel notification.
Role: It is the notification sent by the Object Selector dialog panel, when the Cancel button is pressed.

Parameters:

opDiaCANCELNotification

When the end user clicks on close button.

Returns:

• S_OK if succeeded
• E_FAIL otherwise

Retrieves the End Selection notification.
Role: The method returns the notification sent by the Object Selector dialog panel, when the OK button is pressed.

If the PLM Entity is not already opened in the authoring session, it is done by this method.

Parameters:

opDiaOKNotification

When the end user clicks on OK button.

Returns:

• S_OK if succeeded
• E_FAIL otherwise

Retrieve the current display state of the dialog object.
Role: This Method if effective only after the call to the StartCommand method

Parameters:

oState

The visibility state is:

• CATDlgShow if the dialog object is shown
• CATDlgHide if the dialog object is hidden.

Returns:

• S_OK if succeeded
• E_FAIL otherwise

Defines some public attribute-value pairs. RoleThis method defines a set of public PLM Attribute-value pairs to respect. This method is not mandatory. If you do not call this method, no filter attribute is done. The attribute-values set are visible in the "Advanced Search" panel, only if those are defined in the EZQuery mask scope of the PLM Entity type queried. The attribute-value could be set in user-defined access mode (read, write) in the "Advanced Search" panel. This Method is effective only before the call to the StartCommand method.

Parameters:

iListOfCkeAttributes

It is a list of CATICkeParm object. Each element of the list represents a valid PLM Attribute-value set. By valid, it is implied, those attributes are associated with the PLM Entity type, being queried Use the Knowledge API to create these CATICkeParm object.
Some useful information:

• About the PLM Attribute value
• About the PLM Attribute's editor editability

By default the PLM Attribute values in the "Advanced Search" panel are editable, but you can switch it to non-editable mode like this: Ofcourse, this is relevant provided the Attribute is listed in the Advanced Search panel (defined in the EZQuery mask scope)

          CATICkeParm::UserAccessMode WantedRights = CATICkeParm::ReadOnly;
          spCkeParm -> SetUserAccess (WantedRights); 
         

Returns:

• S_OK if succeeded
• E_FAIL otherwise

Declare tab pages which should appear in the ObjectSelector dialog.

Parameters:

iListOfDataOrigins

The List of wanted tab pages for the ObjectSelector dialog : CATPLMObjectSelectorFile to see the tabpage "From File" CATPLMObjectSelectorQuery to see the tabpage "From Search" CATPLMObjectSelectorSession to see the tabpage "From Session" The first element in iListOfDataOrigins is the tabpage activated by default.

Returns:

• S_OK if succeeded
• E_FAIL otherwise

Sets the PLM Type of the PLM entity to respect.
Role: This method sets the PLM Type of the PLM entity to respect
This Method if effective only before the StartCommand method !.

Parameters:

ispIDataScope

The PLM Type of the PLM entity to respect.

Returns:

• S_OK if succeeded
• E_FAIL otherwise

Sets the NLS title of the dialog object (PLM Object Selector panel).
Role:This method if effective only after the call to the StartCommand method.

Parameters:

iTitle

title of the PLMChooser

Returns:

• S_OK always.
• If the given title is empty, a default title is taken into account "Object Selection".

Sets the current display state of the dialog object (PLM Object Selector panel).
Role:This method if effective only after the call to the StartCommand method.

Parameters:

iState

The visibility state is:

• CATDlgShow if the dialog object is shown
• CATDlgHide if the dialog object is hidden.

Returns:

• S_OK if succeeded
• E_FAIL otherwise

Launches the PLM Object Selector command and its dialog panel.

Parameters:

opEventPublisher

Corresponding command pointer. The method handles the lifecycle of this dialog box command. This pointer must not be released!

Returns:

• S_OK if succeeded
• E_FAIL otherwise

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.