NzaeLibrary Interface reference

This is the Java AE Library API interface.

A reference to this interface can be obtained from the shaper, aggregate or function objects.

Public member functions

NzaeLibraryInfo getLibraryInfo(String name, boolean caseSensitive, int type)
Gets the specified library information.
NzaeLibraryInfo getLocalLibraryInfo(int idx)
Gets the Local library information at the specified index.
NzaeLibraryInfo getParentLibraryInfo(int idx)
Gets the Parent Library information at the specified index.
int sizeLocalEntries()
Gets the number of local entries.
int sizeParentEntries()
Gets the number of parent entries.

Static public attributes

SEARCH_BOTH
Searches both the parent and local contexts.
SEARCH_LOCAL
Searches the local context only.
SEARCH_PARENT
Searches the parent contect only.

Public member functions documentation

NzaeLibraryInfo getLibraryInfo(String name, boolean caseSensitive, int type)
Gets the specified library information.
Parameters

  • name

    The name of the library.

  • caseSensitive

    If FALSE, performs a case-insensitive search

  • type

    Searches the Local context, the Parent context or Both.

Returns

NzaeLibraryInfo

he Library Information or NULL.

In remote mode there is a parent and local context that may be different. The Parent context refers to the libraries used by the AE launcher of the remote AE service process. The Local context refers to the shared libraries specified for the current remote AE instance that is connection to the remote AE ser- vice.

NzaeLibraryInfo getLocalLibraryInfo(int idx)
Gets the Local library information at the specified index.
Parameters

  • idx

    The index to look up.

Returns

NzaeLibraryInfo

The Library Information or NULL.

NzaeLibraryInfo getParentLibraryInfo(int idx)
Gets the Parent Library information at the specified index.
Parameters

  • idx

    The index to look up.

    Returns

    NzaeLibraryInfo

    The Library Information or NULL.

int sizeLocalEntries()
Gets the number of local entries.
Returns

The number of local entries.

The Local Entries are those associated with the AE.

int sizeParentEntries()
Gets the number of parent entries.
Returns

The number of local entries.

The Parent Entries are those associated with the parent process in the case of a remote AE.

Static member data documentation

final int SEARCH_BOTH= 0
Searches both the parent and local contexts.
final int SEARCH_LOCAL= 1
Searches the local context only.
final int SEARCH_PARENT= 2
Searches the parent contect only.