public interface FilterSet extends UserPrefsObject, Serializable
Modifier and Type | Method and Description |
---|---|
int |
addFilter(Filter filter)
Adds a filter to the FilterSet.
|
boolean |
containsFilter(Filter filter)
Checks if a filter is in this filter set.
|
Filter |
createFilter(String name)
Creates an empty
Filter classes in the context of current
FilterSet. |
void |
deleteAll()
Deletes all filters from this filter set.
|
void |
deleteFilter(Filter filter)
Deletes a specific filter from current FilterSet.
|
void |
deleteFilter(int index)
Deletes the filter from the specified position in this list.
|
void |
deleteFilterByName(String filterName)
Deletes a filter from this filter set by filter name.
|
String |
getDescription()
Gets description of this FilterSet.
|
Filter |
getFilter(int index)
Returns the filter at the specified position in this list.
|
List<Filter> |
getFilters()
Get all filters from this filter set in an unmodifiable list.
|
String |
getGuid()
Gets user GUID of this FilterSet.
|
MediaType |
getMediaType()
Gets MediaType of this FilterSet.
|
String |
getXMLString()
Gets XML document that represents the filter set.
|
int |
indexOf(Filter filter)
Gets current index of the filter in the list.
|
void |
moveFilter(int indexFrom,
int indexTo)
Moves filter located at indexFrom to new location, indexTo, in
this filter set.
|
void |
setDescription(String description)
Sets the optional description of the FilterSet.
|
void |
setGuid(String guid)
Sets user GUID of this FilterSet.
|
void |
setMediaType(MediaType mediaType)
Sets MediaType of this FilterSet.
|
int |
size()
Returns total number of filters in this filter set.
|
Element |
toXML(Document doc)
This method is used by the provisioning classes
|
boolean |
validate()
Check that the Object is valid
|
getCreatedDate, getLastModifiedDate, getVersion, isValid, setValid
String getGuid()
void setGuid(String guid)
guid
- GUID of a user.void setDescription(String description)
description
- to be set.String getDescription()
MediaType getMediaType()
void setMediaType(MediaType mediaType)
mediaType
- media type of this FilterSet.boolean containsFilter(Filter filter)
filter
- element whose presence in this list is to be testedFilter
is part of the classvoid deleteFilter(Filter filter)
filter
- to be deleted from current FilterSet.void deleteFilter(int index)
index
- position of filter in the list to be deleted.void deleteFilterByName(String filterName)
filterName
- Name of the filter to be delete from the filter set.void deleteAll()
List<Filter> getFilters()
int addFilter(Filter filter) throws UserPrefsException
UserPrefsException
Filter getFilter(int index)
index
- index of the list.void moveFilter(int indexFrom, int indexTo)
indexFrom
- original position in the list before moving.indexTo
- new position in the list after moving.int indexOf(Filter filter)
filter
- Filter object to be checked.int size()
String getXMLString() throws FilterSetValidationException
FilterSetValidationException
- if the FilterSet is not a valid oneboolean validate() throws FilterSetValidationException
FilterSetValidationException
- if the object is not validFilter createFilter(String name)
Filter
classes in the context of current
FilterSet.name
- Name of the filter to be created.Copyright © 2006, 2017 Oracle and/or its affiliates. All rights reserved.