com.apelon.dts.client.attribute
Class RoleModifier

java.lang.Object
  com.apelon.dts.client.attribute.RoleModifier

public final class RoleModifier
extends Object

RoleModifer is a convenience class of globally accessible constants that define the role modifiers. This allows the API programmer to avoid having strings like "all" and "some" all over the code. Methods exist for converting from/to constants and strings in order to support GUIs, etc. DTS currently supports ALL and SOME for logical modifiers.

Copyright: Copyright (c) 2004

Company: Apelon, Inc.

Since:

DTS 3.3.0

Version:

DTS 3.3.0

Author:

Apelon, Inc

Field Summary

static RoleModifier	ALL The ALL modifier for DTSRoles
static RoleModifier	ALLNOT The @ToDo modifier for DTSRoles
static RoleModifier	ALLOR The @ToDo modifier for DTSRoles
static RoleModifier	NOTALL The @ToDo modifier for DTSRoles
static RoleModifier	NOTSOME The @ToDo modifier for DTSRoles
static RoleModifier	POSS The POSSible modifier for DTSRoles
static RoleModifier	SOME The SOME modifier for DTSRoles
static RoleModifier	SOMENOT The @ToDo modifier for DTSRoles
static RoleModifier	SOMEOR The @ToDo modifier for DTSRoles

Method Summary

int	getId() Retrieves the ID.
String	getName() Retrieves the lowercase name of this modifier (.e.g.
static RoleModifier	toConstant(String name) Converts a string to a RoleModifer, if possible.
String	toString() Returns the name of the modifier.

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final RoleModifier ALL

The ALL modifier for DTSRoles

SOME

public static final RoleModifier SOME

The SOME modifier for DTSRoles

POSS

public static final RoleModifier POSS

The POSSible modifier for DTSRoles

NOTALL

public static final RoleModifier NOTALL

The @ToDo modifier for DTSRoles

NOTSOME

public static final RoleModifier NOTSOME

The @ToDo modifier for DTSRoles

SOMENOT

public static final RoleModifier SOMENOT

The @ToDo modifier for DTSRoles

ALLNOT

public static final RoleModifier ALLNOT

The @ToDo modifier for DTSRoles

SOMEOR

public static final RoleModifier SOMEOR

The @ToDo modifier for DTSRoles

ALLOR

public static final RoleModifier ALLOR

The @ToDo modifier for DTSRoles

Method Detail

getName

public String getName()

Retrieves the lowercase name of this modifier (.e.g. ALL becomes "all")

Returns:

the String which is the name of the modifier

getId

public int getId()

Retrieves the ID. This is used internally by the classifier and is not needed in API programming.

Returns:

the ID of the modifier

toString

public String toString()

Returns the name of the modifier. Convenience method to support print functions.

Overrides:

toString in class Object

Returns:

the name of the modifier.

toConstant

public static RoleModifier toConstant(String name)

Converts a string to a RoleModifer, if possible.

Returns:

the RoleModifer which matches this name or null if there is no match.