PageSet.getReferringObjects (Method)
Returns zero or more structure, each containing information about a referred object; for example, the link and page type, the page's title, and its subsite URL.
Returns:
GetReferringObjects_Result (rowlimitedquery)
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| pageSetID | PageSetID | Required | A page set's ID. |
| limit | QueryRowLimit | Optional. Defaults to '#this.LIMIT_TO_SCALABILITY_MAX#'. | A integer specifying one more than the maximum number of rows CommonSpot can return. If this value is 0, it returns all records. If it is -1, CommonSpot can return the number of records specified in the UI scalability setting. |
| subsiteFilter | SubsiteFilter | Optional. Defaults to '0'. | The subsite's ID. If this value is -1, CommonSpot returns information on the current subsite. If this is 0, CommonSpot returns information for all subsites. |
| includeChildSubsites | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that CommonSpot includes child subsites. |
| dateFilterType | DateFilterType_EmptyString | Optional. Defaults to an empty string. | A string such as 'DateAdded' or 'PublicReleaseDate'. If this is an empty string, CommonSpot does not use a date filter. |
| dateFilter | DateFilterValue_EmptyString | Optional. Defaults to an empty string. | A string such as 'Last 2 months'. An empty string tells CommonSpot that it should not use a date filter value. |
| displayDate | DisplayDate | Optional. Defaults to 'DateContentLastModified'. | A string describing the date field to display; for example, 'DateAdded', 'PublicReleaseDate', and so on. |
| orderBy | SQLOrderByClause | Optional. Defaults to 'Title ASC'. | The SQL 'order by' clause indicating which column is used as the returned data's sort key. |
Context:
| License Requirements | None |
| Permission Requirements | ContributorOrServerCode |
| Deny Context | None |
| Require Context | None |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | This method may be customized at the site level |
Error Codes:
| Code | Error Message |
|---|---|
| 1000200 | If you specify a DateFilterType, you must also specify a DateFilter. |
| 1000201 | If you specify a DateFilter, you must specify a DateFilterType. |
Notes:
None