Class SavedSearchDetails
- java.lang.Object
-
- org.alfresco.module.org_alfresco_module_rm.search.ReportDetails
-
- org.alfresco.module.org_alfresco_module_rm.search.SavedSearchDetails
-
public class SavedSearchDetails extends ReportDetails
Saved search details. Example format of posted Saved Search JSON: { "siteid" : "rm", "name": "search name", "description": "the search description", "search": "the search sting as entered by the user", "public": boolean, "searchparams" : { "maxItems" : 500, "records" : true, "undeclaredrecords" : false, "vitalrecords" : false, "recordfolders" : false, "frozen" : false, "cutoff" : false, "containertypes" : [ "rma:recordSeries", "rma:recordCategory" ] "sort" : [ { "field" : "cm:name", "ascending" : true } ] } } where: name and query values are mandatory, searchparams contains the filters, sort, etc information about the query query is there for backward compatibility note: "params": "terms=keywords:xyz&undeclared=true", "sort": "cm:name/asc" "query": "the complete search query string", ... are sometimes found in the place of searchparams and are migrated to the new format when re-saved params are in URL encoded name/value pair format sort is in comma separated "property/dir" packed format i.e. "cm:name/asc,cm:title/desc"- Author:
- Roy Wetherall
-
-
Field Summary
Fields Modifier and Type Field Description static String
DESCRIPTION
static String
NAME
static String
PARAMS
static String
PUBLIC
static String
QUERY
static String
REPORT
static String
SEARCH
static String
SEARCHPARAMS
static String
SITE_ID
static String
SORT
-
Fields inherited from class org.alfresco.module.org_alfresco_module_rm.search.ReportDetails
description, name, search, searchParameters
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SavedSearchDetailsCompatibility
getCompatibility()
NodeRef
getNodeRef()
String
getSiteId()
boolean
isPublic()
boolean
isReport()
String
toJSONString()
-
Methods inherited from class org.alfresco.module.org_alfresco_module_rm.search.ReportDetails
getDescription, getName, getSearch, getSearchParameters, setDescription, setSearch, setSearchParameters
-
-
-
-
Field Detail
-
SITE_ID
public static final String SITE_ID
- See Also:
- Constant Field Values
-
NAME
public static final String NAME
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final String DESCRIPTION
- See Also:
- Constant Field Values
-
SEARCH
public static final String SEARCH
- See Also:
- Constant Field Values
-
PUBLIC
public static final String PUBLIC
- See Also:
- Constant Field Values
-
REPORT
public static final String REPORT
- See Also:
- Constant Field Values
-
SEARCHPARAMS
public static final String SEARCHPARAMS
- See Also:
- Constant Field Values
-
QUERY
public static final String QUERY
- See Also:
- Constant Field Values
-
SORT
public static final String SORT
- See Also:
- Constant Field Values
-
PARAMS
public static final String PARAMS
- See Also:
- Constant Field Values
-
-
Method Detail
-
getSiteId
public String getSiteId()
- Returns:
-
isPublic
public boolean isPublic()
- Returns:
-
isReport
public boolean isReport()
- Returns:
-
getCompatibility
public SavedSearchDetailsCompatibility getCompatibility()
-
getNodeRef
public NodeRef getNodeRef()
- Returns:
- NodeRef search node ref, null if not set
-
toJSONString
public String toJSONString()
- Returns:
-
-