|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.candle.roma.kxc.RomaDirectoryAgent
This class encapsalates Roma directory access. Each instance uses the supplied context to access the Roma directory and is constructed with the required search criteria. More than one instance may be created using the same context.
A directory item is retrieved by calling the item() method which constructs a RomaDirectoryItem, methods on this are used to access data within the item.
RomaDirectoryItem
Constructor Summary | |
RomaDirectoryAgent(RomaBusinessElement element,
java.lang.String startingPoint,
java.lang.String searchName,
int searchType)
Constructor for business element with no search options |
|
RomaDirectoryAgent(RomaBusinessElement element,
java.lang.String startingPoint,
java.lang.String searchName,
int searchType,
int options)
Constructor for business element with search options |
|
RomaDirectoryAgent(RomaClient client,
java.lang.String startingPoint,
java.lang.String searchName,
int searchType)
Constructor for client with no search options |
|
RomaDirectoryAgent(RomaClient client,
java.lang.String startingPoint,
java.lang.String searchName,
int searchType,
int options)
Constructor for client with search options |
Method Summary | |
protected boolean |
action(RomaDirectoryItem item)
Invoked for each item in the current selection when processAll is called. |
void |
deleteItem(java.lang.String distName,
java.lang.String id,
java.lang.String password)
Delete the item with given distiguished name. |
RomaDirectoryItem |
item(int nItem)
Retrieve nth item form the search. |
RomaDirectoryItem |
item(int nItem,
RomaInteger nModified)
Retrieve nth item form the search and flag whether the directory has been modified. |
void |
lookup(RomaBusinessElement element,
java.lang.String startingPoint,
java.lang.String searchName,
int searchType)
set new parameters for directory search |
void |
lookup(RomaBusinessElement element,
java.lang.String startingPoint,
java.lang.String searchName,
int searchType,
int options)
set new parameters for directory search |
void |
lookup(RomaClient client,
java.lang.String startingPoint,
java.lang.String searchName,
int searchType)
set new parameters for directory search |
void |
lookup(RomaClient client,
java.lang.String startingPoint,
java.lang.String searchName,
int searchType,
int options)
set new parameters for directory search |
int |
matches()
Returns number of matching items. |
int |
matches(RomaInteger modified)
Returns number of matching items and modified flag. |
int |
processAll()
Process each item in the current selection. |
void |
storeItem(RomaDirectoryItem romaDI,
java.lang.String id,
java.lang.String password)
Store item with default options |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public RomaDirectoryAgent(RomaClient client, java.lang.String startingPoint, java.lang.String searchName, int searchType) throws RomaError
client
- should specify a valid clientstartingPoint
- path to starting point of searchsearchName
- search for this namesearcType
- search type. One of the following flags
public RomaDirectoryAgent(RomaClient client, java.lang.String startingPoint, java.lang.String searchName, int searchType, int options) throws RomaError
context
- should specify a valid Client or Business respstartingPoint
- path to starting point of searchsearchName
- search for this namesearcType
- search type. One of the following flags
options
- search option. One of the following flags
public RomaDirectoryAgent(RomaBusinessElement element, java.lang.String startingPoint, java.lang.String searchName, int searchType) throws RomaError
client
- should specify a valid clientstartingPoint
- path to starting point of searchsearchName
- search for this namesearcType
- search type. One of the following flags
public RomaDirectoryAgent(RomaBusinessElement element, java.lang.String startingPoint, java.lang.String searchName, int searchType, int options) throws RomaError
context
- should specify a valid Client or Business respstartingPoint
- path to starting point of searchsearchName
- search for this namesearcType
- search type. One of the following flags
options
- search option. One of the following flags
Method Detail |
public void lookup(RomaClient client, java.lang.String startingPoint, java.lang.String searchName, int searchType) throws RomaError
client
- should specify a valid clientstartingPoint
- path to starting point of searchsearchName
- search for this namesearcType
- search type. One of the following flags
public void lookup(RomaClient client, java.lang.String startingPoint, java.lang.String searchName, int searchType, int options) throws RomaError
context
- should specify a valid Client or Business respstartingPoint
- path to starting point of searchsearchName
- search for this namesearcType
- search type. One of the following flags
options
- search option. One of the following flags
public void lookup(RomaBusinessElement element, java.lang.String startingPoint, java.lang.String searchName, int searchType) throws RomaError
client
- should specify a valid clientstartingPoint
- path to starting point of searchsearchName
- search for this namesearcType
- search type. One of the following flags
public void lookup(RomaBusinessElement element, java.lang.String startingPoint, java.lang.String searchName, int searchType, int options) throws RomaError
context
- should specify a valid Client or Business respstartingPoint
- path to starting point of searchsearchName
- search for this namesearcType
- search type. One of the following flags
options
- search option. One of the following flags
public int matches(RomaInteger modified) throws RomaError
modified
- non-zero value means directory was modifiedpublic int matches() throws RomaError
public RomaDirectoryItem item(int nItem) throws RomaError
nItem
- item required.public RomaDirectoryItem item(int nItem, RomaInteger nModified) throws RomaError
nItem
- item required.mModified
- will be set to 1 if directory modified, else 0public void storeItem(RomaDirectoryItem romaDI, java.lang.String id, java.lang.String password) throws RomaError
romaDI
- item to store.id
- security identitypassword
- security passwordpublic void deleteItem(java.lang.String distName, java.lang.String id, java.lang.String password) throws RomaError
distName
- distiguished namepublic int processAll() throws RomaError
action(com.candle.roma.kxc.RomaDirectoryItem)
protected boolean action(RomaDirectoryItem item)
processAll()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |