Siebel Portal Framework Guide > Delivering Content to External Web Applications > SWE API >

SWE Methods


The InvokeMethod command allows you to invoke methods on a applet, business component, business service, or application. Table 15 lists SWE methods commonly used with the InvokeMethod SWE command.

Table 15.  SWE Methods
Supported Values
Description
Required Args (with Description)
Optional Args (with Description)
CollapseTreeItem
Used in a tree control to collapse an expanded item on the tree.
SWETreeItem: Specify the path of the item relative to root. The path is a string of the form n.n.n.n...where n is an index of an item within its level. The index starts from 1. Example: 1.1.2. SWEView: Name of the view. SWEApplet: Name of the applet.
None
CopyRecord
Performs initialization, then calls CopyRecord on the business component.
None
None
CreateRecord
Performs initialization, then calls NewRecord on the business component.
None
None
DeleteQuery
Deletes a named query.
SweNamedQueries: Specify the name of the named query to be deleted.
None
DeleteRecord
Deletes a record.
None
None
Drilldown
Drills down on the field as specified in the argument SWEField.
SWEField: Specify the name of the applet field that you want to drilldown on. The drilldown information is specified in the repository.
None
EditRecord
Edits a record.
SWESeq: Specify the sequence number of the Edit template. You can have many Edit templates for an applet in Siebel Tools, each identified by the sequence number.
List of arguments with name and value, where the name specifies the field name and the value specifies the field query specification. Will set field query specification before executing the query.
ExecuteQuery
Executes a query. The query specification of the fields is specified in the list of arguments.
None
 
ExecuteNamedQuery
Executes a predefined query (PDQ).
 
SWEView - name of the view.
SWEQueryName - name of the PDQ.
None
ExpandTreeItem
Used in a tree control to expand an item on the tree.
SWETreeItem: Specify the path of the item relative to root. The path is a string of the form n.n.n.n...where n is an index of an item within its level. The index starts from 1. Example: 1.1.2. SWEView: Name of the view. SWEApplet: Name of the applet.
None
GotoFirstSet
Goes to the first set of records. The number of rows in a set is specified in the repository.
None
None
GotoLastSet
Goes to the last set of records.
None
None
GotoNextSet
Goes to the next set of records.
None
None
GotoPreviousSet
Goes to the previous set of records.
None
None
GotoView
Goes to a Siebel view.
If the SWEPostnApplet and SWEPostnRowId arguments are specified, will execute a search for the specified rowId in the specified applet.
If SWEQMApplet and SWEQMMethod arguments are specified, will invoke the method after going to the view.
SWETargetView - name of the view.
SWEKeepContext - if TRUE, keeps the current business object if going to a view that uses the same business object.
SWEPostnApplet - name of the applet that the search should be executed on.
SWEPostnRowId - rowId to search for.
SWEQMApplet - name of the QueueMethod applet. This is the applet where the method (as specified in SWEQMMethod) should be invoked after going to the view.
SWEQMMethod - name of the QueueMethod method. The method to be invoked. You can invoke only one method.
SWEQMArgs - arguments of the QueueMethod method.
Indent
For a hierarchical applet, moves the current record down the hierarchy by one level.
None
None
MoveDown
For a hierarchical applet, moves the current record down the hierarchy within the same level.
None
None
MoveUp
For a hierarchical applet, moves the current record up the hierarchy within the same level.
None
None
NewQuery
Begins a new query.
None
None
NewRecord
If the applet has an association applet, shows the association popup applet. Otherwise, creates a new record.
None
None
NextTreeItem
Used in a tree control to scroll the tree to the next set of record.
SWETreeItem: Specifies the path of the item relative to root. The path is a string of the form n.n.n.n...where n is an index of an item within its level. The index starts from 1. Example: 1.1.2. SWEView: Name of the view. SWEApplet: Name of the applet.
None
Outdent
For a hierarchical applet, moves the current record down the hierarchy by one level.
None
None
PickNone
Makes sure the parent applet field has nothing picked from the pick applet.
None
None
PickRecord
Picks the current row in a pick applet.
None
None
PositionOnRow
Positions the record as specified in the arguments SWERowIds and SWERowId. If no arguments, does nothing.
None
SWERowIds: a string specifying the row Id of the parent buscomps.
SWERowId: the row Id of the record to position to.
PostChanges
Sets the field values as specified in the list of arguments to the record being created or edited.
None
List of arguments with name and value where the name specifies the field name and the value specifies the field value. Will set these field values before committing the record.
PreviousTreeItem
Used in a tree control to scroll the tree to the previous set of records.
SWETreeItem: Specify the path of the item relative to root. The path is a string of the form n.n.n.n...where n is an index of an item within its level. The index starts from 1. Example: 1.1.2. SWEView: Name of the view. SWEApplet: Name of the applet.
None
RefineQuery
Keeps the current field query specification and queries again.
None
None
SaveQueryAs
Saves the current query as a named query. The name is specified in the argument _SweNamedQueries.
SweNamedQueries: Specify the name to save the query as.
None
SelectTreeItem
Used in a tree control to select an item of the tree.
SWETreeItem: Specifies the path of the item relative to root. The path is a string of the form n.n.n.n...where n is an index of an item within its level. The index starts from 1. Example: 1.1.2. SWEView: Name of the view. SWEApplet: Name of the applet.
None
SortAscending
Sorts the field as specified in the argument SWEField in ascending order.
SWEField: Specifies the name of the applet field that you want to sort in ascending order.
None
SortDescending
Sorts the field as specified in the argument SWEField in descending order.
SWEField: Specifies the name of the applet field that you want to sort in descending order.
None
ToggleTo
Toggles to a different toggle applet.
SWESeq: Sequence number of the togglet applet to toggle to.
None
UndoRecord
Undoes a record that is being created or edited.
None
None
WriteRecord
Commits a record that is being created or edited.
SWERowId: Is the Row ID of the record to be saved. SWEReqRowId: Indicates that the Row ID is required in the operation.
None

 Siebel Portal Framework Guide
 Published: 09 September 2004