MetadataServiceWrapper (harmony-hosted-client 1.2.1-SNAPSHOT API)

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.mastersoft.harmony.hosted.client
Class MetadataServiceWrapper

java.lang.Object
  com.mastersoft.harmony.hosted.client.AbstractWrapper
      com.mastersoft.harmony.hosted.client.MetadataServiceWrapper

public class MetadataServiceWrapper
extends AbstractWrapper
extends AbstractWrapper

Wrapper class for invoking methods from the Harmony MetadataService.

Author:: Chris Kasprowicz

Field Summary

Fields inherited from class com.mastersoft.harmony.hosted.client.AbstractWrapper
`REST_SUFFIX`

Constructor Summary
`MetadataServiceWrapper(String baseUrl, String username, String password, com.mastersoft.harmony.hosted.client.model.Locale locale)` Default constructor.

Method Summary
`com.mastersoft.harmony.hosted.client.model.MetadataList`	`floorLevelTypes(com.mastersoft.harmony.hosted.client.model.SourceOfTruth sourceOfTruth)` Retrieves a list of floor level types from the specified Source of Truth.
`com.mastersoft.harmony.hosted.client.model.MetadataList`	`postalTypes(com.mastersoft.harmony.hosted.client.model.SourceOfTruth sourceOfTruth)` Retrieves a list of postal types from the specified Source of Truth.
`com.mastersoft.harmony.hosted.client.model.MetadataList`	`streetSuffixes(com.mastersoft.harmony.hosted.client.model.SourceOfTruth sourceOfTruth)` Retrieves a list of street suffixes from the specified Source of Truth.
`com.mastersoft.harmony.hosted.client.model.MetadataList`	`streetTypes(com.mastersoft.harmony.hosted.client.model.SourceOfTruth sourceOfTruth)` Retrieves a list of street types from the specified Source of Truth.
`com.mastersoft.harmony.hosted.client.model.MetadataList`	`unitFlatTypes(com.mastersoft.harmony.hosted.client.model.SourceOfTruth sourceOfTruth)` Retrieves a list of unit/flat types from the specified Source of Truth.

Methods inherited from class com.mastersoft.harmony.hosted.client.AbstractWrapper
`combineErrorMessages, getLocaleString, getServiceUrl, handleResponse`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

MetadataServiceWrapper

public MetadataServiceWrapper(String baseUrl,
                              String username,
                              String password,
                              com.mastersoft.harmony.hosted.client.model.Locale locale)

Default constructor.

Parameters:: baseUrl - - the base URL for the REST service.; username - - the service username.; password - - the service password.; locale - - a locale to be used when calling the services.

Method Detail

floorLevelTypes

public com.mastersoft.harmony.hosted.client.model.MetadataList floorLevelTypes(com.mastersoft.harmony.hosted.client.model.SourceOfTruth sourceOfTruth)
                                                                        throws ServiceException

Retrieves a list of floor level types from the specified Source of Truth.

Parameters:: sourceOfTruth - - the Source of Truth.
Returns:: a MetadataList object containing the results.
Throws:: MetadataServiceException - - if the retrieval fails.; ServiceException

postalTypes

public com.mastersoft.harmony.hosted.client.model.MetadataList postalTypes(com.mastersoft.harmony.hosted.client.model.SourceOfTruth sourceOfTruth)
                                                                    throws ServiceException

Retrieves a list of postal types from the specified Source of Truth.

Parameters:: sourceOfTruth - - the Source of Truth.
Returns:: a MetadataList object containing the results.
Throws:: MetadataServiceException - - if the retrieval fails.; ServiceException

streetTypes

public com.mastersoft.harmony.hosted.client.model.MetadataList streetTypes(com.mastersoft.harmony.hosted.client.model.SourceOfTruth sourceOfTruth)
                                                                    throws ServiceException

Retrieves a list of street types from the specified Source of Truth.

Parameters:: sourceOfTruth - - the Source of Truth.
Returns:: a MetadataList object containing the results.
Throws:: MetadataServiceException - - if the retrieval fails.; ServiceException

streetSuffixes

public com.mastersoft.harmony.hosted.client.model.MetadataList streetSuffixes(com.mastersoft.harmony.hosted.client.model.SourceOfTruth sourceOfTruth)
                                                                       throws ServiceException

Retrieves a list of street suffixes from the specified Source of Truth.

Parameters:: sourceOfTruth - - the Source of Truth.
Returns:: a MetadataList object containing the results.
Throws:: MetadataServiceException - - if the retrieval fails.; ServiceException

unitFlatTypes

public com.mastersoft.harmony.hosted.client.model.MetadataList unitFlatTypes(com.mastersoft.harmony.hosted.client.model.SourceOfTruth sourceOfTruth)
                                                                      throws ServiceException

Retrieves a list of unit/flat types from the specified Source of Truth.

Parameters:: sourceOfTruth - - the Source of Truth.
Returns:: a MetadataList object containing the results.
Throws:: MetadataServiceException - - if the retrieval fails.; ServiceException