Novell exteNd Director 5.2 API: Interface EbiUserMetaDataQuery

Overview

Package

Class

Tree

Deprecated

Index

Help

Novell exteNd
Director 5.2 API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sssw.fw.usermgr.api
Interface EbiUserMetaDataQuery

All Superinterfaces:: EbiQuery, EbiQueryBase, Serializable

All Known Subinterfaces:: EbiUserQuery

public interface EbiUserMetaDataQuery
extends EbiQuery

This interface defines some of the functionality needed for a User MetaData Query implementation. The subinterfaces fill in the details.

Method Summary

void orderByAttribute(String attributeName, boolean asc)
          Put the corresponding key field into the Order By list for this query.

void orderByEmailAddress(boolean asc)
          Put the emailAddress field into the Order By list for this query.

void orderByFirstName(boolean asc)
          Put the firstName field into the Order By list for this query.

void orderByLastName(boolean asc)
          Put the lastname field into the Order By list for this query.

void orderByRealmName(boolean asc)
          Put the realm field into the Order By list for this query.

void orderByUpdateTime(boolean asc)
          Put the updatetime field into the Order By list for this query.

void orderByUserID(boolean asc)
          Put the user ID field into the Order By list for this query.

void orderByUserUUID(boolean asc)
          Put the user userIID field into the Order By list for this query.

void selectAttribute(String attributeName)
          Select the an attribute and put the corresponding key field into the select list for this query.

void selectEmailAddress()
          Select the emailAddress field into the select list for this query.

void selectFirstName()
          Select the firstName field into the select list for this query.

void selectLastName()
          Select the lastName field into the select list for this query.

void selectRealmName()
          Select the realmName field into the select list for this query.

void selectUpdateTime()
          Select the updatetime field into the select list for this query.

Methods implemented from interface com.sssw.fw.api.EbiQuery

allSelected, deselectAll, getOrderBys, getQueryString, getSelects, removeOrderBys, selectAll

Method Detail

selectFirstName

public void selectFirstName()

Select the firstName field into the select list for this query.

selectLastName

public void selectLastName()

Select the lastName field into the select list for this query.

selectEmailAddress

public void selectEmailAddress()

Select the emailAddress field into the select list for this query.

selectRealmName

public void selectRealmName()

Select the realmName field into the select list for this query.

selectAttribute

public void selectAttribute(String attributeName)

Select the an attribute and put the corresponding key field into the select list for this query.

Note: this method only applies to custom attribute that is defined as base attribute. Use EbiUserMeta.isBaseUserAttribute() to check if the custom attribute is a base attribute.

selectUpdateTime

public void selectUpdateTime()

Select the updatetime field into the select list for this query.

orderByUserUUID

public void orderByUserUUID(boolean asc)

Put the user userIID field into the Order By list for this query.

Parameters:: asc - the sorting order; true for ascending; false for descending

orderByUserID

public void orderByUserID(boolean asc)

Put the user ID field into the Order By list for this query.

Parameters:: asc - the sorting order; true for ascending; false for descending

orderByFirstName

public void orderByFirstName(boolean asc)

Put the firstName field into the Order By list for this query.

Parameters:: asc - the sorting order; true for ascending; false for descending

orderByLastName

public void orderByLastName(boolean asc)

Put the lastname field into the Order By list for this query.

Parameters:: asc - the sorting order; true for ascending; false for descending

orderByEmailAddress

public void orderByEmailAddress(boolean asc)

Put the emailAddress field into the Order By list for this query.

Parameters:: asc - the sorting order; true for ascending; false for descending

orderByRealmName

public void orderByRealmName(boolean asc)

Put the realm field into the Order By list for this query.

Parameters:: asc - the sorting order; true for ascending; false for descending

orderByAttribute

public void orderByAttribute(String attributeName,
                             boolean asc)

Put the corresponding key field into the Order By list for this query.