Package com.appiancorp.suiteapi.content
Class ContentFilter
java.lang.Object
com.appiancorp.suiteapi.content.ContentFilter
Filters may be applied to Content Service operations in order
to filter the final results by the criteria listed here.
All string filters are database regular expressions:
A database regular expression is one executing within backend database, supporting a set of
regular expression patterns.
The following escape character commands are supported:
* matches zero or more characters (e.g., "*.jpg")
? matches exactly one character (e.g., "myfile?.txt")
[characters] matches exactly one of the characters given (e.g., [cC]).
Other characters represent themselves.
Within [characters], additional escape character commands are supported:
^characters is none of the character
character-character is the range of characters in ASCII between the given two characters, such as 0-9 or a-z.
A single character in [] allows escape characters themselves to be represented, such as [*], [?] and [[].
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
This represents a Key and Value of a Content Attribute. -
Field Summary
Modifier and TypeFieldDescriptionstatic final ContentFilter
static final ContentFilter
static final ContentFilter
static final ContentFilter
static final ContentFilter
static final ContentFilter
static final ContentFilter
-
Constructor Summary
ConstructorDescriptionContentFilter
(int typemask_) Constructs a filter which only returns Content items matching the given typemask.ContentFilter
(int typemask_, int subtype_) Constructs a filter which only returns Content items matching the given typemask and subtype.ContentFilter
(Integer typemask_) Constructs a filter which only returns Content items matching the given typemask.ContentFilter
(Integer typemask_, Integer subtype_) Constructs a filter which only returns Content items matching the given typemask and subtype. -
Method Summary
Modifier and TypeMethodDescriptionSet the access level for this filter.Return the attributes searched for by the filter.Returns the description expression of the filter.String[]
Returns the extensions of the filter.getName()
Returns the name expression of the filter.Returns the parent for the filter.getRoot()
Get the root for this filter.Returns the subtype for this filter.Get the typemask for this filter.setAccessLevel
(Integer accessLevel_) Get the access level for this filter.setAttribute
(ContentFilter.KeyValue[] attributes) Set the KeyValues for an attribute search.setDescription
(String description_) Set the description expression of the filter.setExtension
(String[] extension_) Set the extensions of the filter.Set the name expression of the filter.Set the parent for the filter.Set the root for this filter.setSubtype
(Integer subtype_) Set the subtype for this filter.setTypemask
(Integer typemask_) Set the typemask for this filter.
-
Field Details
-
DOCUMENTS
-
FOLDERS
-
RULES
-
RULE_FOLDERS
-
APPLICATIONS
-
KNOWLEDGE_CENTERS
-
ALL
-
-
Constructor Details
-
ContentFilter
public ContentFilter(int typemask_) Constructs a filter which only returns Content items matching the given typemask.- Parameters:
typemask_
- any combination of the TYPE_ constants inContentConstants
-
ContentFilter
public ContentFilter(int typemask_, int subtype_) Constructs a filter which only returns Content items matching the given typemask and subtype.- Parameters:
typemask_
- any combination of the TYPE_ constants inContentConstants
subtype_
- subtype
-
ContentFilter
Constructs a filter which only returns Content items matching the given typemask.- Parameters:
typemask_
- any combination of the TYPE_ constants inContentConstants
-
ContentFilter
Constructs a filter which only returns Content items matching the given typemask and subtype.- Parameters:
typemask_
- any combination of the TYPE_ constants inContentConstants
subtype_
- subtype
-
-
Method Details
-
getSubtype
Returns the subtype for this filter. The subtype must match exactly in order for the Content to be returned, or set to null to ignore.- Returns:
- the subtype
- See Also:
-
setSubtype
Set the subtype for this filter. The subtype must match exactly in order for the Content to be returned, or set to null to ignore.- Parameters:
subtype_
- the subtype, or null to ignore the subtype- Returns:
- the ContentFilter
- See Also:
-
getTypemask
Get the typemask for this filter. The typemask is 'and'ed with the type of the Content, returning the Content where the 'and' is non-0.- Returns:
- the typemask
- See Also:
-
setTypemask
Set the typemask for this filter. The typemask is 'and'ed with the type of the Content, returning the Content where the 'and' is non-0.- Parameters:
typemask_
- any combination of the TYPE_ constants inContentConstants
- Returns:
- the ContentFilter
- See Also:
-
getRoot
Get the root for this filter. Filter will only return content items that are descendants of this root- Returns:
- the root.
- See Also:
-
setRoot
Set the root for this filter. Filter will only return content items that are descendants of this root- Parameters:
root_
- The root to set.- Returns:
- the ContentFilter
- See Also:
-
getAccessLevel
Set the access level for this filter. Filter will only return content of this access level.- Returns:
- the accessLevel.
- See Also:
-
setAccessLevel
Get the access level for this filter. Filter will only return content of this access level.- Parameters:
accessLevel_
- The accessLevel to set.- Returns:
- the ContentFilter
- See Also:
-
getDescription
Returns the description expression of the filter. Filter will only return content items whose descriptions match this regular expression.- Returns:
- Returns the description.
- See Also:
-
setDescription
Set the description expression of the filter. Filter will only return content items whose descriptions match this regular expression.- Parameters:
description_
- The description to set.- Returns:
- the ContentFilter
- See Also:
-
getExtension
Returns the extensions of the filter. Filter will only return content items with the given extensions.- Returns:
- Returns the extension.
- See Also:
-
setExtension
Set the extensions of the filter. Filter will only return content items with the given extensions.- Parameters:
extension_
- The extension to set.- Returns:
- the ContentFilter
- See Also:
-
getName
Returns the name expression of the filter. Filter will only return content items whose names match this regular expression.- Returns:
- Returns the name.
- See Also:
-
setName
Set the name expression of the filter. Filter will only return content items whose names match this regular expression.- Parameters:
name_
- The name to set.- Returns:
- the ContentFilter
- See Also:
-
getParent
Returns the parent for the filter. Filter will only return content items that are children of the given parent.- Returns:
- Returns the parent.
- See Also:
-
setParent
Set the parent for the filter. Filter will only return content items that are children of the given parent.- Parameters:
parent_
- The parent to set.- Returns:
- the ContentFilter
- See Also:
-
getAttributes
Return the attributes searched for by the filter. Filter will only return content items that have attributes with the given name and value from the KeyValue.- Returns:
-
setAttribute
Set the KeyValues for an attribute search. Filter will only return content items that have attributes with the given key and value from the KeyValue.- Parameters:
attribute_
- The name and value of the attribute.- Returns:
- the ContentFilter
- See Also:
-
#getAttribute()
-