|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.portaluiinfrastructure.condition.AConditionType com.plumtree.portaluiinfrastructure.condition.AGuestConditionType com.plumtree.portalpages.condition.conditiontypes.ConditionTypeURLDomain
public class ConditionTypeURLDomain
Field Summary |
---|
Fields inherited from class com.plumtree.portaluiinfrastructure.condition.AConditionType |
---|
CONDITION_LIST_CONSTANT, log, PHASE_TYPE_GUEST, PHASE_TYPE_REGULAR, ruleDebugger |
Constructor Summary | |
---|---|
ConditionTypeURLDomain()
|
Method Summary | |
---|---|
void |
AddItemToMyConditionsList(java.lang.Object objItem,
ExpListModel myListModel,
IPTSession ptSession)
This method is almost like the opposite of the GetConditionValue() method. |
boolean |
Compare(XPHashtable htUserEnvironment,
IValue conditionValue,
XPStringBuilder sbDebugText)
|
java.lang.Object |
GetConditionValue(int nRow,
IPTGrowableSortedArrayWrapperRO saData)
To return the condition value, we have to retrieve the data from the list using the nRow and saData variables. |
int |
GetConditionValueType()
Each condition type has an expectation of what type of value they are to receive. |
void |
GetCurrentValue(XPLimitedRequest xpRequest,
IPTSession guestReadOnlySession,
XPHashtable htUserEnvironment)
GetCurrentValue determines the condition type's current value, and adds it to the htUserEnvironment. |
java.lang.String |
GetDescriptionString(IValue ConditionValue,
IPTSession ptSession)
Constructs the string to be set in an expression's description. |
java.lang.String |
GetMyConditionsListAddLabel(XPResourceManager xpRM,
java.lang.String strLanguage)
The Add label specifies what text will be displayed on the Add button. |
PTImageType |
GetMyConditionsListIcon()
This method specifies what icon will be displayed on the add button. |
java.lang.String |
GetMyConditionsListSectionSubTitle(XPResourceManager xpRM,
java.lang.String strLanguage)
This method specifies what text will be displayed on the section sub title. |
java.lang.String |
GetMyConditionsListSectionTitle(XPResourceManager xpRM,
java.lang.String strLanguage)
This method specifies what text will be displayed on the section title. |
int |
GetTypeID()
|
java.lang.String |
GetValidationFailedString(XPResourceManager xpRM,
java.lang.String strLanguage)
If a ValidationFailedException occurs, the RulesEditorModel will call this method to retrieve the appropriete error message. |
Methods inherited from class com.plumtree.portaluiinfrastructure.condition.AGuestConditionType |
---|
GetPhaseType |
Methods inherited from class com.plumtree.portaluiinfrastructure.condition.AConditionType |
---|
GetConditionTypeIdentifier, InitializeMyConditionsList, RegisterMyConditionsList |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ConditionTypeURLDomain()
Method Detail |
---|
public int GetTypeID()
public boolean Compare(XPHashtable htUserEnvironment, IValue conditionValue, XPStringBuilder sbDebugText)
public void GetCurrentValue(XPLimitedRequest xpRequest, IPTSession guestReadOnlySession, XPHashtable htUserEnvironment)
AGuestConditionType
GetCurrentValue
in class AGuestConditionType
xpRequest
- - http request's wrapper. This is actually another wrapper that conceals the real XPRequest object.
The reason is that at the Guest/Login Phase, the XPRequest's body cannot be parsed. Therefore, any attempt to get
the XPRequest's parameter names or values will result in an exception being thrown.htUserEnvironment
- - the user's environment of current values for condition typespublic java.lang.String GetMyConditionsListSectionTitle(XPResourceManager xpRM, java.lang.String strLanguage)
AConditionType
GetMyConditionsListSectionTitle
in class AConditionType
xpRM
- - the resource manager which can be used to localize strings.strLanguage
- - current user's language locale"The base URL is ANY of the following URLs:"
,
"The user's IP is ANY of the following IPs:"
,
"The user is in ANY of the following Communities:"
,
"The user is in ANY of the following Groups:"
public java.lang.String GetMyConditionsListSectionSubTitle(XPResourceManager xpRM, java.lang.String strLanguage)
AConditionType
GetMyConditionsListSectionSubTitle
in class AConditionType
xpRM
- - the resource manager which can be used to localize strings.strLanguage
- - current user's language locale"URL Domains"
,
"Client IP Addresses"
,
"Community Name"
,
"Group Name"
public java.lang.String GetMyConditionsListAddLabel(XPResourceManager xpRM, java.lang.String strLanguage)
AConditionType
GetMyConditionsListAddLabel
in class AConditionType
xpRM
- - the resource manager which can be used to localize strings.strLanguage
- - current user's language locale"Add URL"
,
"Add an IP Address"
,
"Add Communities"
,
"Add Groups"
public PTImageType GetMyConditionsListIcon()
AConditionType
GetMyConditionsListIcon
in class AConditionType
public int GetConditionValueType()
AConditionType
GetConditionValueType
in class AConditionType
public java.lang.Object GetConditionValue(int nRow, IPTGrowableSortedArrayWrapperRO saData)
AConditionType
GetConditionValue
in class AConditionType
nRow
- - the row index of the object wantedsaData
- - the list containing the object
ConditionTypeURLDomain
public java.lang.String GetValidationFailedString(XPResourceManager xpRM, java.lang.String strLanguage)
AConditionType
GetValidationFailedString
in class AConditionType
xpRM
- - the resource manager which can be used to localize strings.strLanguage
- - current user's language locale
public void AddItemToMyConditionsList(java.lang.Object objItem, ExpListModel myListModel, IPTSession ptSession)
AConditionType
AddItemToMyConditionsList
in class AConditionType
objItem
- - the condition value that needs to be added to the list.myListModel
- - the list model which holds the data of items in the
listptSession
- - the current user's session is provided in case it is neededConditionTypeURLDomain
public java.lang.String GetDescriptionString(IValue ConditionValue, IPTSession ptSession)
AConditionType
GetDescriptionString
in class AConditionType
ConditionValue
- - the condition value for this condition typeptSession
- - the current user's session is provided in case it is needed
"URL Domain contains xxx"
,
"Client IP Address matches xxx.xxx.xxx.xxx"
,
"User is in Community: xxx"
,
"User part of Group: xxx"
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |