public class ShowOrganization extends Organization
Modifier and Type | Field and Description |
---|---|
static java.lang.String | CLASSNAME
Class Name
|
static java.lang.String | COPYRIGHT
IBM Copyright notice field
|
Constructor and Description |
---|
ShowOrganization() |
Modifier and Type | Method and Description |
---|---|
protected void | buildDataArea()
This method builds the Data Area subsection of the reply BOD.
|
org.w3c.dom.Element | buildOrganizationPartyElementBaseInfo(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method builds the OrganizationParty element with the basic information.
|
org.w3c.dom.Element | buildOrganizationPartyElementDetailInfo(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method builds the OrganizationParty element with the detailed information.
|
protected org.w3c.dom.Element | createAddressElement(AddressDataBean abnUserAddress, org.w3c.dom.Element aParentElement)
This method builds the Address element.
|
protected org.w3c.dom.Element | createAddressesElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Addresses element.
|
protected org.w3c.dom.Element | createAddressesElementBaseInfo(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method creates an Addresses element using the base addresses information.
|
protected org.w3c.dom.Element | createAlternatePartyIdsElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method builds the AlternatePartyIds element.
|
protected org.w3c.dom.Element | createBusinessElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Business element.
|
protected org.w3c.dom.Element | createBusinessElementBaseInfo(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Business element with the base information.
|
protected org.w3c.dom.Element | createContactElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Contact element.
|
protected org.w3c.dom.Element | createContactsElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Contacts element.
|
protected org.w3c.dom.Element | createCustomerPartyIdElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method builds the CustomerPartyId element.
|
protected org.w3c.dom.Element | createOrganizationElement(OrganizationSearchResultBean abnOrganizationSearchResult)
This method builds the Organization element.
|
protected org.w3c.dom.Element | createPersonElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method builds the Person element.
|
protected org.w3c.dom.Element | createPersonNameElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method builds the PersonName element.
|
protected org.w3c.dom.Element | createRelatedUnitElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method creates the RelatedUnit element.
|
protected org.w3c.dom.Element | createTelephoneElement(org.w3c.dom.Element aParentElement, java.lang.String astrPhoneNumber, java.lang.String astrPhoneType, java.lang.String astrPublishPhone)
This method creates the Telephone element.
|
protected org.w3c.dom.Element | createUnitElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method creates the Unit element.
|
protected org.w3c.dom.Element | createUserDataElement(AddressDataBean abnAddress, org.w3c.dom.Element aParentElement)
This method creates the user data element for the address element.
|
protected org.w3c.dom.Element | createUserDataElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
This method creates the user data element for the customer element.
|
protected org.w3c.dom.Element | createUserdataInContactElement(AddressDataBean bnUserAddress, OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element contactElement)
This is an empty method to create the UserData element for Contact.
|
protected UserRegistrationDataBean | createUserRegistrationDataBean()
This method creates a UserRegistrationDataBean to be used to do an organization search.
|
protected java.util.ArrayList | executeGetOrganizations(SearchCriteria aSearchCriteria)
This method gets the list of organizations that meet the given search criteria.
|
ITelesalesResponseCacheableCommand | getCacheableCommand()
This method returns an initialized cacheable command.
|
protected java.lang.String | getMaxResultSetSize()
This method returns the maximum result set size which is used by the buildDataArea method to populate the resultSetSize attribute in the response.
|
protected java.lang.String | getRootElementName()
This method gets the root element name of the response document.
|
void | init(CommandContext aCmdCtxt, TypedProperty aRequestProperties, TypedProperty aResponseProperties, org.w3c.dom.Document aRequestBOD, org.w3c.dom.Document aResponseBOD)
This method initializes the necessary parameters before starting to build the response Business Object Document.
|
protected OrganizationSearchResultBean | populateSearchResult(java.lang.String organizationId, OrganizationSearchResultBean abnSearchResult, boolean aboolGetDetails)
This method populates the search result for the given organization.
|
protected void | setMaxResultSetSize(java.lang.String maxResultSetSize)
This method sets the maximum result set size which is used by the buildDataArea method to populate the resultSetSize attribute in the response.
|
public static final java.lang.String CLASSNAME
public static final java.lang.String COPYRIGHT
public void init(CommandContext aCmdCtxt, TypedProperty aRequestProperties, TypedProperty aResponseProperties, org.w3c.dom.Document aRequestBOD, org.w3c.dom.Document aResponseBOD)
This method first calls the init method from the parent class.
It will then call the initializeSearchTypeMapping method to initialize the mappings between the search type obtained from the SelectExpression element in the request Business Object Document to the actual value set to the search bean.
protected void buildDataArea() throws ECException
The following sample indicates the structure of the DataArea element and how it is constructed.
<wc:DataArea> <oa:Show confirm="Always"/> <wc:Organization> <-- createOrganizationElement() --> . . </wc:Organization> <wc:Organization> <-- createOrganizationElement() --> . . </wc:Organization> </wc:DataArea>
protected org.w3c.dom.Element createAddressElement(AddressDataBean abnUserAddress, org.w3c.dom.Element aParentElement) throws ECException
<Address type="SB"> <AddressId/> <!-- abnUserAddress.getAddressId() --> <AddressLine/> <!-- abnUserAddress.getAddress1() --> <AddressLine/> <!-- abnUserAddress.getAddress2() --> <AddressLine/> <!-- abnUserAddress.getAddress3() --> <City/> <!-- abnUserAddress.getCity() --> <PostalCode/> <!-- abnUserAddress.getZipCode() --> <StateOrProvinceCode/> <!-- abnUserAddress.getState() --> <CountryCode/> <!-- abnUserAddress.getCountry() --> <AddressNickName/> <!-- abnUserAddress.getNickName() --> <UserData/> <!-- createUserDataElement() --> </Address>
protected org.w3c.dom.Element createUserDataElement(AddressDataBean abnAddress, org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createAddressesElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement) throws ECException
protected org.w3c.dom.Element createPersonElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<Person> <PersonName/> </Person>
protected org.w3c.dom.Element createPersonNameElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<oa:PersonName> <oa:Salutation/> <oa:GivenName>helen</oa:GivenName> <!-- bnOrgEntity.getAdministratorFirstName() --> <oa:MiddleName>a</oa:MiddleName> <!-- bnOrgEntity.getAdministratorMiddleName() --> <oa:FamilyName>yang</oa:FamilyName> <!-- bnOrgEntity.getAdministratorFirstName() --> <oa:Suffix/> </oa:PersonName>
protected org.w3c.dom.Element createTelephoneElement(org.w3c.dom.Element aParentElement, java.lang.String astrPhoneNumber, java.lang.String astrPhoneType, java.lang.String astrPublishPhone)
<Telephone type="PHN" publish="1">555-1234</Telephone>
protected org.w3c.dom.Element createContactElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<Contact> <oa:Person> <!-- created by the createPersonElement method --> . . </oa:Person> <oa:EMailAddress>helen@ca.ibm.com</oa:EMailAddress> <!-- bnUserAddress.getEmail1() --> <oa:EMailAddress>helen2@ca.ibm.com</oa:EMailAddress> <!-- bnUserAddress.getEmail2() --> <oa:Fax>1234567</oa:Fax> <!-- bnUserAddress.getFax1() --> <oa:Fax>8904566</oa:Fax> <!-- bnUserAddress.getFax2() --> <Telephone publish="0" type=""> <!-- created by the createTelephoneElement method --> . . </Telephone> <Telephone publish="0" type=""> <!-- created by the createTelephoneElement method --> . . </Telephone> <BestCallTime/> <!-- bnUserAddress.getBestCallingTime() --> <UserData> <!-- createUserdataInContactElement(AddressDataBean, OrganizationSearchResultBean, Element) --> <UserDataField name="Name">"Value"</UserDataField> <UserData/> </Contact>
protected org.w3c.dom.Element createUserdataInContactElement(AddressDataBean bnUserAddress, OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element contactElement) throws ECException
... Element userDataElement = createWCDocumentElement(contactElement, BodConstants.TAG_WC_USER_DATA); createUserDataFieldElement(userDataElement, fieldName, fieldValue); ... return userDataElement;
protected org.w3c.dom.Element createContactsElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<Contacts> <Contact> <!-- createContactElement() --> . . </Contact> </Contacts>
protected org.w3c.dom.Element createRelatedUnitElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
<RelatedUnit> <Relationship>Parent</Relationship> <Unit> <-- createUnitElement() --> . . </Unit> </RelatedUnit>
protected org.w3c.dom.Element createUnitElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement)
<Unit> <Id/> <!-- bnParentOrgEntity.getOrgEntityName() --> <Name/> <!-- bnParentOrgEntity.getOrgEntityName() --> </Unit>
public org.w3c.dom.Element buildOrganizationPartyElementDetailInfo(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<OrganizationParty> <PartyId/> <!-- createPartyIdElement() --> <AlternatePartyIds/> <!-- createAlternatePartyIdsElement() --> <Name/> <!-- bnOrgEntity.getOrganizationName() --> <Business/> <!-- createBusinessElement() --> <Description/> <!-- bnOrgEntity.getDescription() --> <Addresses/> <!-- createAddressesElement() --> <Contacts/> <!-- createContactsElement() --> </OrganizationParty>
public org.w3c.dom.Element buildOrganizationPartyElementBaseInfo(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<OrganizationParty> <PartyId/> <!-- createPartyIdElement(bnOrgEntity.getMemberId()) --> <Name/> <!-- bnOrgEntity.getOrganizationName() --> <Business/> <!-- createBusinessElementBaseInfo() --> <Addresses/> <!-- createAddressesElementBaseInfo() --> </OrganizationParty>
protected org.w3c.dom.Element createBusinessElementBaseInfo(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<Business> <Function/> <!-- bnOrgEntity.getOrgEntityType() --> <Name/> <!-- bnOrgEntity.getBusinessCategory() --> </Business>
protected org.w3c.dom.Element createAddressesElementBaseInfo(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement) throws ECException
The following is a sample Addresses element that indicates how the element is constructed:
<Addresses> <Address type="SB"> <AddressId/> <!-- bnUserAddress.getAddressId() -- > <City/> <!-- bnUserAddress.getCity() --> <CountryCode/> <!-- bnUserAddress.getCountry() --> </Address> </Addresses>
protected org.w3c.dom.Element createAlternatePartyIdsElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<AlternatePartyIds> <CustomerPartyId> <!-- createCustomerPartyIdElement() --> </AlternatePartyIds>
protected org.w3c.dom.Element createCustomerPartyIdElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<CustomerPartyId> <Id/> <!-- bnOrgEntity.getDistinguishedName() --> </CustomerPartyId>
protected org.w3c.dom.Element createBusinessElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement) throws ECException
<Business> <Function/> <!-- bnOrgEntity.getOrgEntityType() --> <Name/> <!-- bnOrgEntity.getBusinessCategory() --> <RelatedUnit/> <!-- createRelatedUnitElement() --> </Business>
protected org.w3c.dom.Element createOrganizationElement(OrganizationSearchResultBean abnOrganizationSearchResult) throws ECException
If the organization detailed information is needed (abnOrganizationSearchResult.getRetrieveDetailsFlag returns true), this method calls the buildOrganizationPartyElementDetailInfo method to build the elements. Otherwise, this method calls the buildOrganizationPartyElementBaseInfo method to build the elements.
<Organization> <OrganizationParty/> <!-- buildOrganizationPartyElementDetailInfo() or buildOrganizationPartyElementBaseInfo --> <UserData/> <!-- createUserDataElement --> </Organization>
protected org.w3c.dom.Element createUserDataElement(OrganizationSearchResultBean abnOrganizationSearchResult, org.w3c.dom.Element aParentElement) throws ECException
protected OrganizationSearchResultBean populateSearchResult(java.lang.String organizationId, OrganizationSearchResultBean abnSearchResult, boolean aboolGetDetails) throws ECException
protected UserRegistrationDataBean createUserRegistrationDataBean()
protected java.util.ArrayList executeGetOrganizations(SearchCriteria aSearchCriteria) throws ECException
protected java.lang.String getRootElementName()
public ITelesalesResponseCacheableCommand getCacheableCommand() throws ECException
protected java.lang.String getMaxResultSetSize()
protected void setMaxResultSetSize(java.lang.String maxResultSetSize)