public abstract class AbstractLocationFacadeClient extends AbstractBusinessObjectDocumentFacadeClient
This class provides a set of methods that can be used to communicate with the Location facade. This class represents a library of Location operations that can be performed. The purpose of this class is to hide the details about constructing the business object document that represents the service request into simple Java methods. The complexity of building the request document and making the request is all managed by this client class of the Location facade.
CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CHANGE, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE
Constructor and Description |
---|
AbstractLocationFacadeClient()
Creates an instance of the client to communicate with the Location facade.
|
AbstractLocationFacadeClient(BusinessContextType businessContext,
javax.security.auth.callback.CallbackHandler callbackHandler)
Creates an instance of the client to communicate with the Location facade.
|
Modifier and Type | Method and Description |
---|---|
RespondClientLocationType |
changeClientLocation(ChangeClientLocationType aChangeClientLocation)
This method will communicate with the ClientLocation facade and send the specified
ChangeClientLocation request.
|
RespondPointOfInterestType |
changePointOfInterest(ChangePointOfInterestType aChangePointOfInterest)
This method will communicate with the PointOfInterest facade and send the specified
ChangePointOfInterest request.
|
ShowClientLocationType |
getClientLocation(GetClientLocationType aGetClientLocation)
This method will communicate with the Location facade and send the specified
GetClientLocation.
|
ShowClientLocationDataAreaType |
getClientLocation(GetType getVerb)
This method returns the
ShowClientLocationDataArea when issuing the specified
get expression to fetch ClientLocations. |
java.util.List |
getClientLocation(java.lang.String expressionLanguage,
java.lang.String expression)
This method returns a list of ClientLocations based on the expression specified.
|
ShowPointOfInterestType |
getPointOfInterest(GetPointOfInterestType aGetPointOfInterest)
This method will communicate with the Location facade and send the specified
GetPointOfInterest.
|
ShowPointOfInterestDataAreaType |
getPointOfInterest(GetType getVerb)
This method returns the
ShowPointOfInterestDataArea when issuing the specified
get expression to fetch PointOfInterests. |
java.util.List |
getPointOfInterest(java.lang.String expressionLanguage,
java.lang.String expression)
This method returns a list of PointOfInterests based on the expression specified.
|
AcknowledgeClientLocationType |
processClientLocation(ProcessClientLocationType aProcessClientLocation)
This method will communicate with the Location facade and send the specified
ProcessClientLocation request.
|
AcknowledgePointOfInterestType |
processPointOfInterest(ProcessPointOfInterestType aProcessPointOfInterest)
This method will communicate with the Location facade and send the specified
ProcessPointOfInterest request.
|
createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb
public AbstractLocationFacadeClient()
public AbstractLocationFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
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.public ShowPointOfInterestType getPointOfInterest(GetPointOfInterestType aGetPointOfInterest)
aGetPointOfInterest
- The GetPointOfInterest request document.ShowPointOfInterest
response document.public AcknowledgePointOfInterestType processPointOfInterest(ProcessPointOfInterestType aProcessPointOfInterest)
aProcessPointOfInterest
- The ProcessPointOfInterest request document.public RespondPointOfInterestType changePointOfInterest(ChangePointOfInterestType aChangePointOfInterest)
aChangePointOfInterest
- The ChangePointOfInterest request document.public ShowPointOfInterestDataAreaType getPointOfInterest(GetType getVerb) throws PointOfInterestException
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.getVerb
- The get expression to execute.ShowPointOfInterestDataArea
response when issuing the get expression.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.public java.util.List getPointOfInterest(java.lang.String expressionLanguage, java.lang.String expression) throws PointOfInterestException
expressionLanguage
- The expression lanaguage.expression
- The expression to return a list of PointOfInterests.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.public ShowClientLocationType getClientLocation(GetClientLocationType aGetClientLocation)
aGetClientLocation
- The GetClientLocation request document.ShowClientLocation
response document.public AcknowledgeClientLocationType processClientLocation(ProcessClientLocationType aProcessClientLocation)
aProcessClientLocation
- The ProcessClientLocation request document.public RespondClientLocationType changeClientLocation(ChangeClientLocationType aChangeClientLocation)
aChangeClientLocation
- The ChangeClientLocation request document.public ShowClientLocationDataAreaType getClientLocation(GetType getVerb) throws ClientLocationException
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.getVerb
- The get expression to execute.ShowClientLocationDataArea
response when issuing the get expression.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.public java.util.List getClientLocation(java.lang.String expressionLanguage, java.lang.String expression) throws ClientLocationException
expressionLanguage
- The expression lanaguage.expression
- The expression to return a list of ClientLocations.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.