com.webmethods.portal.service.meta2.query

Interface IThingContainerQuery

public interface IThingContainerQuery

Method Summary

Modifier and Type	Method and Description
IThingIDList	getChildrenByName(IThingID thingID, String name, int relType, int xtypeID, int startIndex, int endIndex) returns all children whose name exactly matches (case-insensitive) 'name' Will check all languages
int	getCount(IThingID thingID, int relType, int typeID, int xtypeID) Get a count of children of this container, based on relationship type.
IThingChildList	listChilds(IThingID containerID) Get all things that are childs of the specified container.
IThingIDList	listIDs(IThingID thingID, int startIndex, int endIndex) Get things that are contained by this thing
IThingIDList	listIDsByType(IThingID thingID, int startIndex, int endIndex, int typeID) Return list of all children with this type
IThingIDList	listIDsByXType(IThingID thingID, int startIndex, int endIndex, int xtypeID) Return list of all children with this xtype
IThingIDList	searchChildrenByName(IThingID thingID, String query, int relType, int xtypeID, int startIndex, int endIndex) returns all children whose name exactly matches 'name' if includeLink is true, also includes matches on link name.

Method Detail

listChilds

IThingChildList listChilds(IThingID containerID)
                    throws MetaException

Get all things that are childs of the specified container. This method returns all things and does not do any acl checks

Returns:

Throws:

MetaException

listIDs

IThingIDList listIDs(IThingID thingID,
                     int startIndex,
                     int endIndex)
              throws MetaException

Get things that are contained by this thing

Parameters:

startIndex - index of the first item to return.

endIndex - index of the last item to return. -1 specifies the last item.

Returns:

array of thingIDs

Throws:

MetaException

listIDsByType

IThingIDList listIDsByType(IThingID thingID,
                           int startIndex,
                           int endIndex,
                           int typeID)
                    throws MetaException

Return list of all children with this type

Parameters:

startIndex - index of the first item to return.

endIndex - index of the last item to return. -1 specifies the last item.

Throws:

MetaException

listIDsByXType

IThingIDList listIDsByXType(IThingID thingID,
                            int startIndex,
                            int endIndex,
                            int xtypeID)
                     throws MetaException

Return list of all children with this xtype

Parameters:

startIndex - index of the first item to return.

endIndex - index of the last item to return. -1 specifies the last item.

Throws:

MetaException

getCount

int getCount(IThingID thingID,
             int relType,
             int typeID,
             int xtypeID)
      throws MetaException

Get a count of children of this container, based on relationship type.

Parameters:

relType - -1 specifies all containment relationships. (IRelation)

typeID - -1 specifies all item types (IThingType)

xtypeID - -1 specifies all xtypes

Throws:

MetaException

getChildrenByName

IThingIDList getChildrenByName(IThingID thingID,
                               String name,
                               int relType,
                               int xtypeID,
                               int startIndex,
                               int endIndex)
                        throws MetaException

returns all children whose name exactly matches (case-insensitive) 'name' Will check all languages

Parameters:

name - (case-insensitive) name to search for

relType - relation type to search on

xtypeID - 0 means all, else filter

startIndex - for paging

endIndex - for paging, -1 for all

Returns:

list of children matching name (may be several)

Throws:

MetaException - if container not found or DB error

searchChildrenByName

IThingIDList searchChildrenByName(IThingID thingID,
                                  String query,
                                  int relType,
                                  int xtypeID,
                                  int startIndex,
                                  int endIndex)
                           throws MetaException

returns all children whose name exactly matches 'name' if includeLink is true, also includes matches on link name. Will check all languages

Parameters:

query - name to search for

relType - relation type to search on

xtypeID - 0 means all, else filter

startIndex - for paging

endIndex - for paging, -1 for all

Returns:

list of children matching name (may be several)

Throws:

MetaException - if container not found or DB error