wt.prefs
Interface PrefEntry

All Known Implementing Classes:

AbstractPrefEntry, DBPrefEntry, UndefinedPrefEntry

public interface PrefEntry

Supported API: false

Extendable: false

Field Summary

static String	CONTEXT Label for the attribute.
static String	NAME Label for the attribute.
static String	NODE Label for the attribute.
static String	PARENT Label for the attribute.
static String	VALUE Label for the attribute.

Method Summary

String[]	children(String[] search_context) Supported API: false
void	delete() Supported API: false
String	getContext() Gets the value of the attribute: CONTEXT.
String	getName() Gets the value of the attribute: NAME.
String	getNode() Gets the value of the attribute: NODE.
String	getParent() Gets the value of the attribute: PARENT.
String	getValue() Gets the value of the attribute: VALUE.
void	persist() Supported API: false
PrefEntry	retrieve() This method will perform the retrieval of Preference Information (if appropriate) for the given PrefEntry from the back-end store.
PrefEntry[]	retrieveAll() This method will perform the retrieval of Preference Information (if appropriate) for the given PrefEntry from the back-end store.
ArrayList	search(String search, String[] contexts, boolean isLike) This will search the Preference Entry for the search string.
void	setContext(String a_Context) Sets the value of the attribute: CONTEXT.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setNode(String a_Node) Sets the value of the attribute: NODE.
void	setParent(String a_Parent) Sets the value of the attribute: PARENT.
void	setValue(String a_Value) Sets the value of the attribute: VALUE.
void	update() This method should force an update on the PrefEntry information to the backing-store according to the current state of the PrefEntry Supported API: false

Field Detail

PARENT

public static final String PARENT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

NAME

public static final String NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

VALUE

public static final String VALUE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

NODE

public static final String NODE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CONTEXT

public static final String CONTEXT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

Method Detail

getParent

public String getParent()

Gets the value of the attribute: PARENT.

Supported API: false

Returns:

String

setParent

public void setParent(String a_Parent)
               throws WTPropertyVetoException

Sets the value of the attribute: PARENT.

Supported API: false

Parameters:

a_Parent -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getValue

public String getValue()

Gets the value of the attribute: VALUE.

Supported API: false

Returns:

String

setValue

public void setValue(String a_Value)
              throws WTPropertyVetoException

Sets the value of the attribute: VALUE.

Supported API: false

Parameters:

a_Value -

Throws:

WTPropertyVetoException

getNode

public String getNode()

Gets the value of the attribute: NODE.

Supported API: false

Returns:

String

setNode

public void setNode(String a_Node)
             throws WTPropertyVetoException

Sets the value of the attribute: NODE.

Supported API: false

Parameters:

a_Node -

Throws:

WTPropertyVetoException

getContext

public String getContext()

Gets the value of the attribute: CONTEXT.

Supported API: false

Returns:

String

setContext

public void setContext(String a_Context)
                throws WTPropertyVetoException

Sets the value of the attribute: CONTEXT.

Supported API: false

Parameters:

a_Context -

Throws:

WTPropertyVetoException

retrieve

public PrefEntry retrieve()

This method will perform the retrieval of Preference Information (if appropriate) for the given PrefEntry from the back-end store.

Supported API: false

Returns:

PrefEntry

update

public void update()
            throws WTException

This method should force an update on the PrefEntry information to the backing-store according to the current state of the PrefEntry

Supported API: false

Throws:

WTException

persist

public void persist()

Supported API: false

delete

public void delete()

Supported API: false

retrieveAll

public PrefEntry[] retrieveAll()

This method will perform the retrieval of Preference Information (if appropriate) for the given PrefEntry from the back-end store. All entries will be retrieved (since the name could be null)

Supported API: false

Returns:

PrefEntry[]

children

public String[] children(String[] search_context)

Supported API: false

Parameters:

search_context - The context(s) to search the children for

Returns:

String[]

search

public ArrayList search(String search,
                        String[] contexts,
                        boolean isLike)
                 throws WTException

This will search the Preference Entry for the search string. The string will be enclosed with '%' as a wildcard. Also '%' may appear elsewhere in the string indicating a wildcard. if two '%%' appear this represents an actual '%' character. This method should return an ArrayList of matching PrefSearch objects. If there are no items then the ArrayList should be empty but not null PrefSearch API can be found in the Javadoc.

Supported API: false

Parameters:

search - The string to search for

contexts - The list of search contexts to use for the search.

isLike - Whether the search is a LIKE search or exact match

Returns:

ArrayList

Throws:

WTException