Reports.getLockedPages (Method)
Returns zero or more structures, each containing information on locked pages. This method's arguments limit the information returned.
Returns:
Reports_GetLockedPages_Result (rowlimitedquery)
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| userID | UserID_0_NEG1 | Optional. Defaults to '-1'. | A comma-delimited list of user IDs. Values that have special meaning are: 0 (for all users), or -1 (current user). |
| lockTypeFilter | LockTypeFilter | Optional. Defaults to 'All'. | The type of lock for which CommonSpot will search; for example, permanent or temporary. |
| subsiteFilter | SubsiteFilter | Optional. Defaults to '0'. | The ID of the subsite in which CommonSpot searches for objects. If this argument's value is 0, CommonSpot searches all subsites. If this argument's value is -1, CommonSpot searches in the current subsite. |
| includeChildSubsites | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true tells CommonSpot that the results should include pages from all child subsites. |
| dateFilterType | DateFilterType_EmptyString | Optional. Defaults to an empty string. | A string describing the date filter; for example, 'DateAdded' or 'PublicReleaseDate'. CommonSpot uses this value when looking for objects. If this argument is an empty string, CommonSpot does not use a date filter type. |
| dateFilter | DateFilterValue_EmptyString | Optional. Defaults to an empty string. | Sets the value of the filter that CommonSpot uses when returning results; for example 'This year', 'Last month', 'Last 2 months'. and so on. |
| orderBy | SQLOrderByClause | Optional. Defaults to 'Title'. | The SQL 'order by' clause indicating which column is used as the returned data's sort key. |
| limit | QueryRowLimit | Optional. Defaults to '#this.LIMIT_TO_SCALABILITY_MAX#'. | An integer specifying one more than the maximum number of rows CommonSpot can return. Values with special meaning are: 0: Returns all records. -1: Return the number of records specified in the UI scalability setting. |
| displayDate | DisplayDate | Optional. Defaults to 'DateContentLastModified'. | A string describing the date field to display; for example, 'DateModified' or 'PublicReleaseDate'. |
| ownershipFilter | OwnerIDList_0_NEG1_NEG2_EmptyString | Optional. Defaults to an empty string. | A string describing the ownershipfilter; for example, '0' for objects owned by current user, '-1' for objects owned by current user's groups, '-2' for objects owned by current user and his/her groups or a list of ownerIDs and empty string for no filter. |
Context:
| License Requirements | (none) |
| Permission Requirements | ContributorOrServerCode |
| Deny Context | (none) |
| Require Context | Authoring |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
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