TermsAndConditionsRequest (anonlib 00.21.029-SNAPSHOT API)

java.lang.Object
- anon.terms.TermsAndConditionsRequest

All Implemented Interfaces:: IXMLEncodable

public class TermsAndConditionsRequest
extends java.lang.Object
implements IXMLEncodable

XML structure sent to the mix during login to request lacking TermsAndConditions items which are required to be accepted before connecting to the corresponding cascade. Resource requests are added by the corresponding add-methods An example for a resulting XML request document:

Modifier and Type	Class and Description
`private static class`	`TermsAndConditionsRequest.TCRequestKey` simple class to build a key with language and the operator subject key identifier.
`private static class`	`TermsAndConditionsRequest.TCRequestValue` a corresponding value wrapper class for the resource items hashtable

Modifier and Type	Field and Description
`private java.util.Hashtable`	`requestedItems` stores the requested T&C resources. the key that maps to the entries is built by the operator subject key identifier and the language.
`private java.util.Vector`	`requestedTemplates` to remember which templates are already requested.
`private java.util.Hashtable`	`resourceRootElements` stores the resource root elements for the operators.
`static java.lang.String`	`XML_ATTR_LOCALE`
`static java.lang.String`	`XML_ELEMENT_CONTAINER_NAME`
`static java.lang.String`	`XML_ELEMENT_NAME`
`static java.lang.String`	`XML_ELEMENT_REQ_TRANSLATION`
`static java.lang.String`	`XML_ELEMENT_RESOURCE_CUSTOMIZED_SECT`
`static java.lang.String`	`XML_ELEMENT_RESOURCE_TEMPLATE`
`static java.lang.String`	`XML_MSG_TC_CONFIRM`
`static java.lang.String`	`XML_MSG_TC_INTERRUPT`

Modifier and Type	Method and Description
`void`	`addCustomizedSectionsRequest(ServiceOperator operator, java.lang.String langCode)` adds a request for the individual T&C sections of the given operator in the the specified language.
`private void`	`addResourceRequest(java.lang.String resourceType, ServiceOperator operator, java.lang.String langCode)` private util function for adding a generic resource request.
`void`	`addTemplateRequest(ServiceOperator operator, java.lang.String langCode, java.lang.String templateRefID)` adds a template request for the given operator and language the templateRefid needs to be specified to avoid multiple requests of the same template.
`void`	`checkRequestPostCondition()` To be called after the mix response was handled.
`boolean`	`hasResourceRequests()`
`org.w3c.dom.Element`	`toXmlElement(org.w3c.dom.Document a_doc)` Return an element that can be appended to the document.

Class TermsAndConditionsRequest

Nested Class Summary

Field Summary

Fields inherited from interface anon.util.IXMLEncodable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

XML_ELEMENT_NAME

XML_ELEMENT_CONTAINER_NAME

XML_ATTR_LOCALE

XML_ELEMENT_REQ_TRANSLATION

XML_ELEMENT_RESOURCE_TEMPLATE

XML_ELEMENT_RESOURCE_CUSTOMIZED_SECT

XML_MSG_TC_INTERRUPT

XML_MSG_TC_CONFIRM

requestedTemplates

requestedItems

resourceRootElements

Constructor Detail

TermsAndConditionsRequest

Method Detail

addTemplateRequest

addCustomizedSectionsRequest

addResourceRequest

hasResourceRequests

toXmlElement

checkRequestPostCondition