weave.servlets

Interface IWeaveEntityService

All Known Implementing Classes:

DataService

public interface IWeaveEntityService

Interface for a service which provides RPC functions for retrieving Weave Entity information.

Author:

adufilie

Method Summary

Methods

Modifier and Type	Method and Description
int[]	findEntityIds(java.util.Map<java.lang.String,java.lang.String> publicMetadata, java.lang.String[] wildcardFields) Gets an Array of entity IDs with matching public metadata.
java.lang.String[]	findPublicFieldValues(java.lang.String fieldName, java.lang.String valueSearch) Finds matching values for a public metadata field.
DataConfig.DataEntityWithRelationships[]	getEntities(int[] ids) Gets an Array of Entity objects, minus the private metadata.
DataConfig.EntityHierarchyInfo[]	getHierarchyInfo(java.util.Map<java.lang.String,java.lang.String> publicMetadata) Gets EntityHierarchyInfo objects containing basic information on entities matching public metadata.

Method Detail

getHierarchyInfo

DataConfig.EntityHierarchyInfo[] getHierarchyInfo(java.util.Map<java.lang.String,java.lang.String> publicMetadata)
                                                  throws java.rmi.RemoteException

Gets EntityHierarchyInfo objects containing basic information on entities matching public metadata.

Parameters:

publicMetadata - EntityMetadata containing values to match.

Returns:

An Array of EntityHierarchyInfo objects, sorted by title.

Throws:

java.rmi.RemoteException

getEntities

DataConfig.DataEntityWithRelationships[] getEntities(int[] ids)
                                                     throws java.rmi.RemoteException

Gets an Array of Entity objects, minus the private metadata.

Parameters:

ids - A list of entity IDs.

Returns:

An Array of Entity objects.

Throws:

java.rmi.RemoteException

findEntityIds

int[] findEntityIds(java.util.Map<java.lang.String,java.lang.String> publicMetadata,
                  java.lang.String[] wildcardFields)
                    throws java.rmi.RemoteException

Gets an Array of entity IDs with matching public metadata.

Parameters:

publicMetadata - Public metadata to search for.

wildcardFields - A list of field names in publicMetadata that should be treated as search strings with wildcards '?' and '*' for single-character and multi-character matching, respectively.

Returns:

An Array of IDs matching the search criteria.

Throws:

java.rmi.RemoteException

findPublicFieldValues

java.lang.String[] findPublicFieldValues(java.lang.String fieldName,
                                       java.lang.String valueSearch)
                                         throws java.rmi.RemoteException

Finds matching values for a public metadata field.

Parameters:

fieldName - The name of the public metadata field to search.

valueSearch - A search string.

Returns:

An Array of matching values for the specified public metadata field.

Throws:

java.rmi.RemoteException