Home > Contents > Index >
SPGetChildren
Returns a list of child nodes for the specified SitePlan node.
Syntax
SPGetChildren(java.lang.String authusername, java.lang.String authpassword, java.lang.String NODEID, java.lang.String CODE, java.lang.String CHILDTYPE, java.lang.String CHILDID, java.lang.String ORDER)Parameters
authusername (required)
- (String) Name of the user to log in, as registered in Sites .
authpassword(required)
- (String) Password for the associated user name.
NODEID (required)
- (String) ID of the node for which you want to return child nodes.
CODE (optional)
- (String) The name of the association that describes the relationship between the child node and the parent node. Restricts the list of children to children whose pages are designated as either placed or unplaced relationships. Placed pages are those that have been set to a particular level in the tree hierarchy. Unplaced pages are those pages that have yet to be placed, or that are intentionally left unplaced.
- Valid values are either
Placed
orUnplaced
.
CHILDTYPE (optional)
- (String) Restricts the list to nodes of a specific child-asset type, which must be
Page
. You can combine this parameter with theChildID
parameter to request one specific node.
CHILDID (optional)
- (String) The object ID of the specific child node to return. If you supply a child ID, you must also use the associated
CHILDTYPE
parameter. If noCHILDID
parameter is specified, theGetChildren
operation returns all children for the asset.
ORDER (optional)
- (String) Name of the asset column (field) used to sort the results, specified as a string.
- The fields to sort the list by, and whether the sort result on those fields is
ascending
ordescending
. By default, the sort isascending
. If you specify more than one field, separate the field names with a comma.
- For example, if you specify O
RDER="nrank"
, the list is sorted by rank starting at number 1. If you want the list sorted by descending rank, useORDER="nrank desc"
.
Description
This operation queries the SitePlanTree table for a list of the child nodes of the node that you specify, listing each child with a value for all of the fields from that table (
nid
,nparentid
,nrank
,otype
,oid
, andncode
).You can restrict the list of children nodes by association name (
CODE
),CHILDTYPE
,CHILDID
, and rank (ORDER
).If you specify
Page
for theCHILDTYPE
parameter, the list of children is a join of the SitePlanTree and the Page table.Returns
A list of SitePlan child nodes.
Error Numbers
The possible values of
errno
include:
Value Description -111 The asset has no children. -10004 A required parameter is missing. -10005 The requested object is not in the object pool (is not loaded into memory). -10006 The object ID is not valid. -10007 The version of the object is not valid.
Example
This following example code logs in the user, extracts the child pages for the page asset identified as the node ID (
nid
) of the page:SitePlanService service = new SitePlanServiceLocator(); SitePlanPortType port = service.getSitePlanPort(); IList myList = port.SPGetChildren("user_author", "demo", "968685129229", null, null, null, null);
Home > Contents > Index > ![]()
Oracle Web Services Reference
Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved.