|
|
The file DCBFWCollection.idl contains the following interfaces:
DCBFWCollection::KeyedObjectCollection DCBFWCollection::ObjectCollection DCBFWCollection::StringCollection
The DCBFWCollection module defines three generic collection interfaces:
These three generic interfaces are based on the types that are also declared in the module-scoped namespace.
You can use these collections if you like, but they are presented here primarily as examples of how to generate custom collections. You can find a few such applications of autogenerated custom collections in the CiscoAcctMonitor and CiscoSlaMonitor modules, which are supplied with the Cisco VPN Solutions Center software.
See Also
ObjectCollection, StringCollection, KeyedObjectCollection, CiscoAcctMonitor, CiscoSlaMonitor
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sequence of Object types.
Usage
typedef sequence<Object> ObjectSeq
See Also
ObjectCollection, KeyedObjectCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sequence of string types.
Usage
typedef sequence<string> StringSeq
See Also
StringCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Indicates an attempt to access elements beyond the end of the collection.
Usage
exception EndOfCollectionException
{
long dummy;
};
Parameters
dummy—long value that represents the index at the end of the collection.
See Also
getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Indicates collection is not validated by the server.
Usage
exception InvalidatedException
{
string explanation;
};
Parameters
explanation—string that describes the conditions that caused the exception to be raised.
Description
A server can explicitly invalidate a collection if it must revoke access to the Object or String types within the collection.
See Also
ObjectCollection, StringCollection, KeyedObjectCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Indicates an attempt to access an invalid index within a collection.
Usage
exception InvalidIndexException
{
long index;
};
Parameters
index—long value that represents the invalid index.
See Also
setIndex, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
An instance of the KeyedObjectCollection interface provides a means by which to interact with a keyed collection of IDL Object types.
Description
Because this interface is derived from the ObjectCollection interface, you can access keyed collection elements as a large array. In addition, a KeyedObjectCollection has a unique key assigned to each element by which clients can retrieve elements by key value. All keys are simple string types.
See Also
ObjectCollection::dispose, ObjectCollection, StringCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the element associated with a specified key.
Usage
Object elementAtKey(in string key)
raises(InvalidatedException);
Parameters
key—in string that represents the key for the element to get.
Returns
Object that represents the KeyedObjectCollection element that is associated with the specified key. If the specified key does not exist in the collection, the elementAtKey() operation returns NULL.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
See Also
key, elementsAtKeys, ObjectCollection::size, ObjectCollection::setIndex, ObjectCollection::getIndex, ObjectCollection::nextElement, ObjectCollection::nextElements, ObjectCollection::elementAtIndex, ObjectCollection::elementsAtIndex, ObjectCollection::dispose
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the KeyedObjectCollection elements associated with a series of keys.
Usage
ObjectSeq elementsAtKeys(in StringSeq keys)
raises(InvalidatedException);
Parameters
keys—in DCBFWCollection::StringSeq that represents the keys for the KeyedObjectCollection elements to get.
Returns
ObjectSeq that represent the requested KeyedObjectCollection elements. If the key does not exist in the collection, the element returned at the corresponding index is NULL. The collection may also return fewer elements than were requested to reduce the message size, but a minimum of one collection element is always returned.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
See Also
key, elementAtKey, ObjectCollection::size, ObjectCollection::setIndex, ObjectCollection::getIndex, ObjectCollection::nextElement, ObjectCollection::nextElements, ObjectCollection::elementAtIndex, ObjectCollection::elementsAtIndex, ObjectCollection::dispose
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets a StringCollection object that contains the keys for the KeyedObjectCollection elements.
Usage
StringCollection keys(); raises(InvalidatedException);
Returns
DCBFWCollection::StringCollection that represents the keys for this collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
There is exactly one element for each key.
See Also
elementAtKey, elementsAtKeys, ObjectCollection::size, ObjectCollection::setIndex, ObjectCollection::getIndex, ObjectCollection::nextElement, ObjectCollection::nextElements, ObjectCollection::elementAtIndex, ObjectCollection::elementsAtIndex, ObjectCollection::dispose
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
An instance of the ObjectCollection interface provides a means by which to interact with a collection of IDL Object types.
Description
The Object types in the collection are managed as an ObjectSeq type or a list of IDL Object types. Using the operations that are supplied in this interface, you can programmatically retrieve objects from the collection in either sequential or random order.
See Also
ObjectCollection::dispose, StringCollection, KeyedObjectCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
readonly attribute long size
A readonly attribute that represents the number of elements in the ObjectCollection collection.
See Also
setIndex, getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, dispose
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Disposes the ObjectCollection object and frees the server resources that are associated with it.
Usage
void dispose();
Description
Once executed, the ObjectCollection object is no longer accessible by the client. In addition, the server may free this object automatically after some time. Program your clients to retrieve data from a collection when it is first is acquired, rather than waiting before examining the data.
See Also
ObjectCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the ObjectCollection element at the specified index.
Usage
Object elementAtIndex(in long index)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the element to get.
Returns
Object that represents the specified ObjectCollection element.
Raises
DCBFWCollection::InvalidIndexException if the index isinvalid. An invalid index only occurs if a client explictly the indexto an invalid value using the setIndex() operation. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.
See Also
setIndex, getIndex, nextElement, nextElements, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets a specified number of ObjectCollection elements at the specified index.
Usage
ObjectSeq elementsAtIndex(in long index, in long numberOfElements)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the first element to get.
numberOfElements—in long that indicates the number of ObjectCollection elements to get.
Returns
ObjectSeq that represent the specified ObjectCollection elements.
Raises
DCBFWCollection::InvalidIndexException if the index isinvalid. An invalid index only occurs if a client explictly the indexto an invalid value using the setIndex() operation. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, ObjectCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.
Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.
See Also
setIndex, getIndex, nextElement, nextElements, elementAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the index value of the current ObjectCollection element.
Usage
long getIndex(); raises(InvalidatedException);
Returns
long—Index of the element at the current position in the ObjectCollection collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The ObjectCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.
See Also
setIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the next ObjectCollection element.
Usage
Object nextElement(); raises(EndOfCollectionException, InvalidatedException);
Returns
Object that represents the next ObjectCollection element.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
Executing the nextElement() operation increments the sequential index.
See Also
setIndex, getIndex, nextElements, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the next few ObjectCollection elements.
Usage
ObjectSeq nextElements(in long numberOfElements)
raises(EndOfCollectionException, InvalidatedException);
Parameters
numberOfElements—in long that indicates the number of elements to get.
Returns
ObjectSeq that represent the next few ObjectCollection elements as specified by the numberOfElements input value.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, ObjectCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.
See Also
setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sets the index value of the current ObjectCollection element.
Usage
void setIndex(in long index)
raises(InvalidatedException, InvalidIndexException);
Parameters
index—in long that represents the index to value assign to the current ObjectCollection element.
Raises
DCBFWCollection::InvalidIndexException if the index isinvalid. An invalid index only occurs if a client explictly the indexto an invalid value using the setIndex() operation. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The ObjectCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.
See Also
getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
An instance of the StringCollection interface provides a means by which to interact with a collection of IDL string types.
Description
The string types in the collection are managed as a StringSeq type or a list of string types. Using the operations that are supplied in this interface, you can programmatically retrieve strings from the collection in either sequential or random order.
See Also
StringCollection::dispose, ObjectCollection, KeyedObjectCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
readonly attribute long size
A readonly attribute that represents the number of elements in the StringCollection collection.
See Also
setIndex, getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, dispose
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Disposes the StringCollection object and frees the server resources that are associated with it.
Usage
void dispose();
Description
Once executed, the StringCollection object is no longer accessible by the client. In addition, the server may free this object automatically after some time. Program your clients to retrieve data from a collection when it is first is acquired, rather than waiting before examining the data.
See Also
StringCollection
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the StringCollection element at the specified index.
Usage
string elementAtIndex(in long index)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the element to get.
Returns
string that represents the specified StringCollection element.
Raises
DCBFWCollection::InvalidIndexException if the index isinvalid. An invalid index only occurs if a client explictly the indexto an invalid value using the setIndex() operation. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.
See Also
setIndex, getIndex, nextElement, nextElements, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets a specified number of StringCollection elements at the specified index.
Usage
StringSeq elementsAtIndex(in long index, in long numberOfElements)
raises(InvalidIndexException, InvalidatedException);
Parameters
index—in long value that specifies the index of the first element to get.
numberOfElements—in long that indicates the number of StringCollection elements to get.
Returns
StringSeq that represent the specified StringCollection elements.
Raises
DCBFWCollection::InvalidIndexException if the index isinvalid. An invalid index only occurs if a client explictly the indexto an invalid value using the setIndex() operation. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, StringCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.
Note: This operation does not affect the sequential index used by the nextElement() and nextElements() operations.
See Also
setIndex, getIndex, nextElement, nextElements, elementAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the index value of the current StringCollection element.
Usage
long getIndex(); raises(InvalidatedException);
Returns
long—Index of the element at the current position in the StringCollection collection.
Raises
DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The StringCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.
See Also
setIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the next StringCollection element.
Usage
string nextElement(); raises(EndOfCollectionException, InvalidatedException);
Returns
string that represents the next StringCollection element.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
Executing the nextElement() operation increments the sequential index.
See Also
setIndex, getIndex, nextElements, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Gets the next few StringCollection elements.
Usage
StringSeq nextElements(in long numberOfElements)
raises(EndOfCollectionException, InvalidatedException);
Parameters
numberOfElements—in long that indicates the number of elements to get.
Returns
StringSeq that represent the next few StringCollection elements as specified by the numberOfElements input value.
Raises
DCBFWCollection::EndOfCollectionException if the end ofthe collection is reached without returning any items. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
If the end of the collection is reached before the specified numberOfElements is returned, StringCollection elements are returned until the end of the collection is reached. The collection may also return fewer elements than requested to reduce the message size, but a minimum of one collection element is returned, if available.
See Also
setIndex, getIndex, nextElement, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Sets the index value of the current StringCollection element.
Usage
void setIndex(in long index)
raises(InvalidatedException, InvalidIndexException);
Parameters
index—in long that represents the index to value assign to the current StringCollection element.
Raises
DCBFWCollection::InvalidIndexException if the index isinvalid. An invalid index only occurs if a client explictly the indexto an invalid value using the setIndex() operation. DCBFWCollection::InvalidatedException if this collectionis invalidated by the server.
Description
The StringCollection index is initialized to 0 and is incremented when collection elements are traversed sequentially using the nextElement() or nextElements() operations.
See Also
getIndex, nextElement, nextElements, elementAtIndex, elementsAtIndex, size
Since
Data Collection Base Framework, Release 1.0
Cisco VPN Solutions Center, Release 1.0
Posted: Tue Sep 26 16:50:20 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.