weave.servlets

Interface IWeaveEntityManagementService

All Known Implementing Classes:

AdminService

public interface IWeaveEntityManagementService

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

Author:

adufilie

Method Summary

Methods

Modifier and Type	Method and Description
int[]	addChild(int parentId, int childId, int insertAtIndex) Adds a parent-child relationship to the server-side entity hierarchy table.
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.
DataConfig.EntityHierarchyInfo[]	getHierarchyInfo(java.util.Map<java.lang.String,java.lang.String> publicMetadata) Gets EntityHierarchyInfo objects containing basic information on entities matching public metadata.
int	newEntity(DataConfig.DataEntityMetadata metadata, int parentId, int insertAtIndex) Creates a new entity.
void	removeChild(int parentId, int childId) Removes a parent-child relationship from the server-side entity hierarchy table.
int[]	removeEntities(int[] entityIds) Removes entities and their children recursively.
void	updateEntity(int entityId, DataConfig.DataEntityMetadata diff) Updates the metadata for an existing entity.

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.

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

newEntity

int newEntity(DataConfig.DataEntityMetadata metadata,
            int parentId,
            int insertAtIndex)
              throws java.rmi.RemoteException

Creates a new entity.

Parameters:

metadata - Metadata for the new entity.

parentId - The parent entity ID, or -1 for no parent.

insertAtIndex - Specifies insertion index for sort order.

Returns:

An entity ID.

Throws:

java.rmi.RemoteException

updateEntity

void updateEntity(int entityId,
                DataConfig.DataEntityMetadata diff)
                  throws java.rmi.RemoteException

Updates the metadata for an existing entity.

Parameters:

entityId - An entity ID.

diff - Specifies the changes to make to the metadata.

Throws:

java.rmi.RemoteException

removeEntities

int[] removeEntities(int[] entityIds)
                     throws java.rmi.RemoteException

Removes entities and their children recursively.

Parameters:

entityIds - A list of entity IDs to remove.

Returns:

An Array of entity IDs that were removed.

Throws:

java.rmi.RemoteException

addChild

int[] addChild(int parentId,
             int childId,
             int insertAtIndex)
               throws java.rmi.RemoteException

Adds a parent-child relationship to the server-side entity hierarchy table.

Parameters:

parentId - The ID of the parent entity.

childId - The ID of the child entity.

insertAtIndex - Specifies insertion index for sort order.

Returns:

An Array of IDs whose relationships have changed as a result of adding the parent-child relationship.

Throws:

java.rmi.RemoteException

removeChild

void removeChild(int parentId,
               int childId)
                 throws java.rmi.RemoteException

Removes a parent-child relationship from the server-side entity hierarchy table.

Parameters:

parentId - The ID of the parent entity.

childId - The ID of the child entity.

Throws:

java.rmi.RemoteException