Package com.isode.dsapi.config

Class DSACreationTemplate.IndexRequest

java.lang.Object

com.isode.dsapi.config.DSACreationTemplate.IndexRequest

Enclosing class:

DSACreationTemplate

public class DSACreationTemplate.IndexRequest
extends Object

Class representing a request for an index to be created in all the GDAMs of the new DSA.

Since:

16.0

Author:

tc

Field Summary

Fields

Modifier and Type	Field	Description
IndexEntry.IndexMatchType	match
AttributeType	type

Constructor Summary

Constructors

Constructor	Description
IndexRequest(String at, String mt)	Create a new index request

Method Summary

Modifier and Type	Method	Description
String	getIndexName()	Return a string giving the name of the index to be created.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

type

public AttributeType type

match

public IndexEntry.IndexMatchType match

Constructor Details

IndexRequest

public IndexRequest(String at,
 String mt)
             throws BadAttributeTypeException,
BadValueException

Create a new index request

Parameters:

at - Name of attribute type to index which may not be null

mt - Index match type - must be one of "eq", "sub" "approx" or "pres"

Throws:

BadAttributeTypeException

BadValueException

Method Details

getIndexName

public String getIndexName()

Return a string giving the name of the index to be created.

Returns:

Index name string, which will never be null