|
Oracle® WebCenter Content Remote Intradoc Client (RIDC) Java API Reference 11g Release 1 (11.1) E17274-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.stellent.ridc.filter.IdcFilterManager
public class IdcFilterManager
Manage a list of filters that are registered to be executed. RIDC code will call executeFilters at various strategic points in the library. Application code can register a filter to be executed at a particular time (slot) in relation to all other registered filters. If the slot you want to use is currently in use, then the next higher available slot will be automatically selected. Application code can also deregister a filter from a slot. To guard against accidentally deregistering the wrong filter, you need to also specify the instance of the filter in that slot.
Constructor Summary | |
---|---|
IdcFilterManager() |
Method Summary | |
---|---|
IIdcFilter |
deRegisterFilter(int slot, IIdcFilter filter) Remove a filter from an execution slot. |
void |
executeFilters(IdcFilterType ftype, java.lang.Object... objects) Execute the filters beforeServiceRequest method |
IIdcFilter |
getFilter(int slot) Get filter that will execute at a specific slot value |
java.util.List<java.lang.Integer> |
getUsedSlots() |
int |
registerFilter(int slot, IIdcFilter filter) Register a filter that will be called during processing of the RIDC event. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IdcFilterManager()
Method Detail |
---|
public void executeFilters(IdcFilterType ftype, java.lang.Object... objects) throws IdcClientException
IdcFilterException
IdcClientException
public int registerFilter(int slot, IIdcFilter filter) throws IdcFilterException
slot
- Execution slot for the filter, slots are executed in orderfilter
- IIdcFilter classIdcFilterException
- if the filter cannot be registeredpublic IIdcFilter deRegisterFilter(int slot, IIdcFilter filter) throws IdcFilterException
slot
- the filter slot to vacatefilter
- the instance that previously occupied slotIdcFilterException
public IIdcFilter getFilter(int slot)
slot
- execution slotpublic java.util.List<java.lang.Integer> getUsedSlots()
|
Oracle® WebCenter Content Remote Intradoc Client (RIDC) Java API Reference 11g Release 1 (11.1) E17274-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |