Constructor Detail

• AbstractLocationFacadeClient

  public AbstractLocationFacadeClient()
  

  Creates an instance of the client to communicate with the Location facade.

• AbstractLocationFacadeClient

  public AbstractLocationFacadeClient(BusinessContextType businessContext,
                              javax.security.auth.callback.CallbackHandler callbackHandler)
  

  Creates an instance of the client to communicate with the Location facade.

  Parameters:

  businessContext - The default business context to associate with the messages when making requests.

  callbackHandler - Used for authentication purposes so the controller can give the authentication information to the transport when required.

Method Detail

• getLocationFactory

  protected LocationFactory getLocationFactory()
  

  This method will return the default instance of the Location Factory. This factory can be used to create objects defined by the Location.

  Returns:

  The default Location Factory.

• getPointOfInterest

  public ShowPointOfInterestType getPointOfInterest(GetPointOfInterestType aGetPointOfInterest)
  

  This method will communicate with the Location facade and send the specified GetPointOfInterest. request.

  Parameters:

  aGetPointOfInterest - The GetPointOfInterest request document.

  Returns:

  The resulting ShowPointOfInterest response document.

• processPointOfInterest

  public AcknowledgePointOfInterestType processPointOfInterest(ProcessPointOfInterestType aProcessPointOfInterest)
  

  This method will communicate with the Location facade and send the specified ProcessPointOfInterest request.

  Parameters:

  aProcessPointOfInterest - The ProcessPointOfInterest request document.

  Returns:

  The resulting AcknowledgePointOfInterest response document.

• changePointOfInterest

  public RespondPointOfInterestType changePointOfInterest(ChangePointOfInterestType aChangePointOfInterest)
  

  This method will communicate with the PointOfInterest facade and send the specified ChangePointOfInterest request.

  Parameters:

  aChangePointOfInterest - The ChangePointOfInterest request document.

  Returns:

  The resulting RespondPointOfInterest response document.

• checkAcknowledgePointOfInterest

  protected AcknowledgePointOfInterestDataAreaType checkAcknowledgePointOfInterest(AcknowledgePointOfInterestDataAreaType acknowledgePointOfInterestDataArea)
                                                                            throws PointOfInterestException
  

  This method will examine the AcknowledgePointOfInterestDataArea to see if there is any error information reported. If there is, then the PointOfInterestException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single PointOfInterest.

  Parameters:

  acknowledgePointOfInterestDataArea - The acknowledge PointOfInterest data area to inspect.

  Returns:

  The specified AcknowledgePointOfInterestDataArea if no error information is found.

  Throws:

  PointOfInterestException - The PointOfInterestException is thrown if error information is found in the specified AcknowledgePointOfInterestDataArea. This will represent that there was a problem when performing the operation.

• checkRespondPointOfInterest

  protected RespondPointOfInterestDataAreaType checkRespondPointOfInterest(RespondPointOfInterestDataAreaType respondPointOfInterestDataArea)
                                                                    throws PointOfInterestException
  

  This method will examine the RespondPointOfInterestDataArea to see if there is any error information reported. If there is, then the PointOfInterestException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single PointOfInterest.

  Parameters:

  respondPointOfInterestDataArea - The respond PointOfInterest data area to inspect.

  Returns:

  The specified RespondPointOfInterestDataArea if no error information is found.

  Throws:

  PointOfInterestException - The PointOfInterestException is thrown if error information is found in the specified RespondPointOfInterestDataArea. This will represent that there was a problem when performing the operation.

• checkShowPointOfInterest

  protected ShowPointOfInterestDataAreaType checkShowPointOfInterest(ShowPointOfInterestDataAreaType showPointOfInterestDataArea)
                                                              throws PointOfInterestException
  

  This method will examine the ShowPointOfInterestDataArea to see if there is any error information reported. If there is, then the PointOfInterestException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single PointOfInterest.

  Parameters:

  showPointOfInterestDataArea - The show PointOfInterest data area to inspect.

  Returns:

  The specified ShowPointOfInterestDataArea if no error information is found.

  Throws:

  PointOfInterestException - The PointOfInterestException is thrown if error information is found in the specified ShowPointOfInterestDataArea. This will represent that there was a problem when performing the operation.

• getPointOfInterest

  public ShowPointOfInterestDataAreaType getPointOfInterest(GetType getVerb)
                                                     throws PointOfInterestException
  

  This method returns the ShowPointOfInterestDataArea when issuing the specified get expression to fetch PointOfInterests. This method will be used by other framworks or methods that constructs the get expression.

  Parameters:

  getVerb - The get expression to execute.

  Returns:

  The ShowPointOfInterestDataArea response when issuing the get expression.

  Throws:

  PointOfInterestException - The PointOfInterestException is thrown if error information is found in the specified ShowPointOfInterestDataArea. This will represent that there was a problem when performing the operation.

• getPointOfInterest

  public java.util.List getPointOfInterest(java.lang.String expressionLanguage,
                                  java.lang.String expression)
                                    throws PointOfInterestException
  

  This method returns a list of PointOfInterests based on the expression specified.

  Parameters:

  expressionLanguage - The expression lanaguage.

  expression - The expression to return a list of PointOfInterests.

  Returns:

  The list of PointOfInterests that matches the expression specified.

  Throws:

  PointOfInterestException - The PointOfInterestException is thrown if error information is found in the specified ShowPointOfInterestDataArea. This will represent that there was a problem when performing the operation.

• getClientLocation

  public ShowClientLocationType getClientLocation(GetClientLocationType aGetClientLocation)
  

  This method will communicate with the Location facade and send the specified GetClientLocation. request.

  Parameters:

  aGetClientLocation - The GetClientLocation request document.

  Returns:

  The resulting ShowClientLocation response document.

• processClientLocation

  public AcknowledgeClientLocationType processClientLocation(ProcessClientLocationType aProcessClientLocation)
  

  This method will communicate with the Location facade and send the specified ProcessClientLocation request.

  Parameters:

  aProcessClientLocation - The ProcessClientLocation request document.

  Returns:

  The resulting AcknowledgeClientLocation response document.

• changeClientLocation

  public RespondClientLocationType changeClientLocation(ChangeClientLocationType aChangeClientLocation)
  

  This method will communicate with the ClientLocation facade and send the specified ChangeClientLocation request.

  Parameters:

  aChangeClientLocation - The ChangeClientLocation request document.

  Returns:

  The resulting RespondClientLocation response document.

• checkAcknowledgeClientLocation

  protected AcknowledgeClientLocationDataAreaType checkAcknowledgeClientLocation(AcknowledgeClientLocationDataAreaType acknowledgeClientLocationDataArea)
                                                                          throws ClientLocationException
  

  This method will examine the AcknowledgeClientLocationDataArea to see if there is any error information reported. If there is, then the ClientLocationException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single ClientLocation.

  Parameters:

  acknowledgeClientLocationDataArea - The acknowledge ClientLocation data area to inspect.

  Returns:

  The specified AcknowledgeClientLocationDataArea if no error information is found.

  Throws:

  ClientLocationException - The ClientLocationException is thrown if error information is found in the specified AcknowledgeClientLocationDataArea. This will represent that there was a problem when performing the operation.

• checkRespondClientLocation

  protected RespondClientLocationDataAreaType checkRespondClientLocation(RespondClientLocationDataAreaType respondClientLocationDataArea)
                                                                  throws ClientLocationException
  

  This method will examine the RespondClientLocationDataArea to see if there is any error information reported. If there is, then the ClientLocationException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single ClientLocation.

  Parameters:

  respondClientLocationDataArea - The respond ClientLocation data area to inspect.

  Returns:

  The specified RespondClientLocationDataArea if no error information is found.

  Throws:

  ClientLocationException - The ClientLocationException is thrown if error information is found in the specified RespondClientLocationDataArea. This will represent that there was a problem when performing the operation.

• checkShowClientLocation

  protected ShowClientLocationDataAreaType checkShowClientLocation(ShowClientLocationDataAreaType showClientLocationDataArea)
                                                            throws ClientLocationException
  

  This method will examine the ShowClientLocationDataArea to see if there is any error information reported. If there is, then the ClientLocationException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single ClientLocation.

  Parameters:

  showClientLocationDataArea - The show ClientLocation data area to inspect.

  Returns:

  The specified ShowClientLocationDataArea if no error information is found.

  Throws:

  ClientLocationException - The ClientLocationException is thrown if error information is found in the specified ShowClientLocationDataArea. This will represent that there was a problem when performing the operation.

• getClientLocation

  public ShowClientLocationDataAreaType getClientLocation(GetType getVerb)
                                                   throws ClientLocationException
  

  This method returns the ShowClientLocationDataArea when issuing the specified get expression to fetch ClientLocations. This method will be used by other framworks or methods that constructs the get expression.

  Parameters:

  getVerb - The get expression to execute.

  Returns:

  The ShowClientLocationDataArea response when issuing the get expression.

  Throws:

  ClientLocationException - The ClientLocationException is thrown if error information is found in the specified ShowClientLocationDataArea. This will represent that there was a problem when performing the operation.

• getClientLocation

  public java.util.List getClientLocation(java.lang.String expressionLanguage,
                                 java.lang.String expression)
                                   throws ClientLocationException
  

  This method returns a list of ClientLocations based on the expression specified.

  Parameters:

  expressionLanguage - The expression lanaguage.

  expression - The expression to return a list of ClientLocations.

  Returns:

  The list of ClientLocations that matches the expression specified.

  Throws:

  ClientLocationException - The ClientLocationException is thrown if error information is found in the specified ShowClientLocationDataArea. This will represent that there was a problem when performing the operation.