com.plumtree.uiinfrastructure.constants
Class AccessStyles

java.lang.Object
  com.plumtree.uiinfrastructure.constants.AccessStyles

public class AccessStyles
extends java.lang.Object

AccessStyles is an emumeration of the various access types allowed.

Author:

John Osborne

Field Summary

static AccessStyles	LOW_BANDWIDTH A 508-like style UI that allows for regular gadgets to be displayed
static AccessStyles	SECTION_508 The style that is 508 complant
static AccessStyles	STANDARD The standard portal style

Method Summary

int	GetAccessID() Gives back the integer representation of the access style.
static AccessStyles	GetAccessStyle(int nAccessStyle) This converts an int into an Access Style.
static int	GetDefaultAccessID() Returns the default access ID.
static boolean	IsValidAccessID(int _nAccessID) JF- Helper method to validate an Access ID.
java.lang.String	ToString() Gives back the string representation of the access style.

Methods inherited from class java.lang.Object

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

Field Detail

STANDARD

public static final AccessStyles STANDARD

The standard portal style

SECTION_508

public static final AccessStyles SECTION_508

The style that is 508 complant

LOW_BANDWIDTH

public static final AccessStyles LOW_BANDWIDTH

A 508-like style UI that allows for regular gadgets to be displayed

Method Detail

GetAccessStyle

public static AccessStyles GetAccessStyle(int nAccessStyle)

This converts an int into an Access Style. This is necessary because the access style comes from the portal, where it is stored as an int, rather than an enumerator.

Returns:

AccessStyles the enumerator value of the int. null if there was an error

GetAccessID

public int GetAccessID()

Gives back the integer representation of the access style. NOTE: This is the right way to work; the above method is for debug purposes.

Returns:

An integer version of the access style.

ToString

public java.lang.String ToString()

Gives back the string representation of the access style.

Returns:

A string version of the access style. For example, if the mode is SECTION_508, you get back the string: "SECTION_508". In the event of an error, null is returned.

IsValidAccessID

public static boolean IsValidAccessID(int _nAccessID)

JF- Helper method to validate an Access ID.

Parameters:

_nAccessID - ID to validate

Returns:

boolean

GetDefaultAccessID

public static int GetDefaultAccessID()

Returns the default access ID.

Returns:

int