com.sas.metadata.remote
Interface Location

All Superinterfaces:

CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, java.rmi.Remote, Root, SecondaryType

public interface Location
extends SecondaryType

This type represents a location that includes a type (is it a street address, or an office number), as well as address information (street, city, country).

Attributes of Location are:

• LocationType
• Address
• City
• PostCode
• Area
• Country

Associations of Location are:

• Persons

Usage

To create an instance of this Location, use the factory create methods.
Example: create a Location with name "Location_Object", in repository "AAAAAAAA".

 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 Location myObject = (Location) factory.createComplexMetadataObject(objectStore, "Location_Object", MetadataObjects.LOCATION, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed
 

Behavior

• Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
• When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
• If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:

9.0

Field Summary

static java.lang.String	ASSOCIATION_PERSONS_NAME Constant used for the name of the Persons association.
static java.lang.String	ATTRIBUTE_ADDRESS_NAME Constant used for the name of the Address attribute.
static java.lang.String	ATTRIBUTE_AREA_NAME Constant used for the name of the Area attribute.
static java.lang.String	ATTRIBUTE_CITY_NAME Constant used for the name of the City attribute.
static java.lang.String	ATTRIBUTE_COUNTRY_NAME Constant used for the name of the Country attribute.
static java.lang.String	ATTRIBUTE_LOCATIONTYPE_NAME Constant used for the name of the LocationType attribute.
static java.lang.String	ATTRIBUTE_POSTCODE_NAME Constant used for the name of the PostCode attribute.

Fields inherited from interface com.sas.metadata.remote.Root

ASSOCIATION_ACCESSCONTROLS_NAME, ASSOCIATION_CHANGES_NAME, ASSOCIATION_CUSTOMASSOCIATIONS_NAME, ASSOCIATION_DOCUMENTS_NAME, ASSOCIATION_EXTENSIONS_NAME, ASSOCIATION_EXTERNALIDENTITIES_NAME, ASSOCIATION_GROUPS_NAME, ASSOCIATION_IMPLEMENTORS_NAME, ASSOCIATION_KEYWORDS_NAME, ASSOCIATION_LOCALIZEDATTRIBUTES_NAME, ASSOCIATION_NOTES_NAME, ASSOCIATION_PRIMARYPROPERTYGROUP_NAME, ASSOCIATION_PROMPTS_NAME, ASSOCIATION_PROPERTIES_NAME, ASSOCIATION_PROPERTYSETS_NAME, ASSOCIATION_REFERENCEDOBJECTS_NAME, ASSOCIATION_RESPONSIBLEPARTIES_NAME, ASSOCIATION_SOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECSOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECTARGETTRANSFORMATIONS_NAME, ASSOCIATION_TARGETTRANSFORMATIONS_NAME, ASSOCIATION_TIMESTAMPS_NAME, ASSOCIATION_TREES_NAME, ASSOCIATION_TSOBJECTNAMESPACE_NAME, ASSOCIATION_USEDBYPROTOTYPES_NAME, ASSOCIATION_USINGPROTOTYPE_NAME, ASSOCIATION_VARIABLES_NAME, ATTRIBUTE_CHANGESTATE_NAME, ATTRIBUTE_LOCKEDBY_NAME, ATTRIBUTE_USAGEVERSION_NAME

Fields inherited from interface com.sas.metadata.remote.MdObjectBase

ATTRIBUTE_DESC_NAME, ATTRIBUTE_ID_NAME, ATTRIBUTE_METADATACREATED_NAME, ATTRIBUTE_METADATAUPDATED_NAME, ATTRIBUTE_NAME_NAME

Method Summary

abstract java.lang.String	getAddress() Gets the String value of Address
abstract int	getAddressMaxLength() Gets the maximum length of Address
abstract int	getAddressState() Gets the Metadata State of Address
abstract java.lang.String	getArea() Gets the String value of Area
abstract int	getAreaMaxLength() Gets the maximum length of Area
abstract int	getAreaState() Gets the Metadata State of Area
abstract java.lang.String	getCity() Gets the String value of City
abstract int	getCityMaxLength() Gets the maximum length of City
abstract int	getCityState() Gets the Metadata State of City
abstract java.lang.String	getCountry() Gets the String value of Country
abstract int	getCountryMaxLength() Gets the maximum length of Country
abstract int	getCountryState() Gets the Metadata State of Country
abstract java.lang.String	getLocationType() Gets the String value of LocationType
abstract int	getLocationTypeMaxLength() Gets the maximum length of LocationType
abstract int	getLocationTypeState() Gets the Metadata State of LocationType
abstract AssociationList	getPersons() Gets the Association list of Persons
abstract AssociationList	getPersons(boolean fGoToServer) Gets the Associationlist of Persons
abstract java.lang.String	getPostCode() Gets the String value of PostCode
abstract int	getPostCodeMaxLength() Gets the maximum length of PostCode
abstract int	getPostCodeState() Gets the Metadata State of PostCode
abstract void	initializePredObjects() (S) Adds the Associated objects to the predObjects which are:
abstract void	initializeRequiredObjects() (S) This initializes the Required Objects(Roles) which are:
abstract void	setAddress(java.lang.String inAddress) Sets the Address value and sets the state to MetadataState.LOCAL.
abstract void	setAddress(java.lang.String inAddress, int state) Sets the Address Metadata State.
abstract void	setAddressState(int state) Sets the Metadata State of Address.
abstract void	setArea(java.lang.String inArea) Sets the Area value and sets the state to MetadataState.LOCAL.
abstract void	setArea(java.lang.String inArea, int state) Sets the Area Metadata State.
abstract void	setAreaState(int state) Sets the Metadata State of Area.
abstract void	setCity(java.lang.String inCity) Sets the City value and sets the state to MetadataState.LOCAL.
abstract void	setCity(java.lang.String inCity, int state) Sets the City Metadata State.
abstract void	setCityState(int state) Sets the Metadata State of City.
abstract void	setCountry(java.lang.String inCountry) Sets the Country value and sets the state to MetadataState.LOCAL.
abstract void	setCountry(java.lang.String inCountry, int state) Sets the Country Metadata State.
abstract void	setCountryState(int state) Sets the Metadata State of Country.
abstract void	setLocationType(java.lang.String inLocationType) Sets the LocationType value and sets the state to MetadataState.LOCAL.
abstract void	setLocationType(java.lang.String inLocationType, int state) Sets the LocationType Metadata State.
abstract void	setLocationTypeState(int state) Sets the Metadata State of LocationType.
abstract void	setPersons(AssociationList list) Sets the Persons list to be list.
abstract void	setPersons(AssociationList inObjects, int state) Sets the entire Persons list to match the passed in AssociationList, sets the state of the Persons
abstract void	setPostCode(java.lang.String inPostCode) Sets the PostCode value and sets the state to MetadataState.LOCAL.
abstract void	setPostCode(java.lang.String inPostCode, int state) Sets the PostCode Metadata State.
abstract void	setPostCodeState(int state) Sets the Metadata State of PostCode.

Methods inherited from interface com.sas.metadata.remote.Root

getAccessControls, getAccessControls, getChanges, getChanges, getChangeState, getChangeStateMaxLength, getChangeStateState, getCustomAssociations, getCustomAssociations, getDocuments, getDocuments, getExtensions, getExtensions, getExternalIdentities, getExternalIdentities, getGroups, getGroups, getImplementors, getImplementors, getKeywords, getKeywords, getLocalizedAttributes, getLocalizedAttributes, getLockedBy, getLockedByMaxLength, getLockedByState, getNotes, getNotes, getPrimaryPropertyGroup, getPrimaryPropertyGroups, getPrimaryPropertyGroups, getPrompts, getPrompts, getProperties, getProperties, getPropertySets, getPropertySets, getReferencedObjects, getReferencedObjects, getResponsibleParties, getResponsibleParties, getSourceTransformations, getSourceTransformations, getSpecSourceTransformations, getSpecSourceTransformations, getSpecTargetTransformations, getSpecTargetTransformations, getTargetTransformations, getTargetTransformations, getTimestamps, getTimestamps, getTrees, getTrees, getTSObjectNamespace, getTSObjectNamespaces, getTSObjectNamespaces, getUsageVersion, getUsageVersionState, getUsedByPrototypes, getUsedByPrototypes, getUsingPrototype, getUsingPrototypes, getUsingPrototypes, getVariables, getVariables, setAccessControls, setAccessControls, setChanges, setChanges, setChangeState, setChangeState, setChangeStateState, setCustomAssociations, setCustomAssociations, setDocuments, setDocuments, setExtensions, setExtensions, setExternalIdentities, setExternalIdentities, setGroups, setGroups, setImplementors, setImplementors, setKeywords, setKeywords, setLocalizedAttributes, setLocalizedAttributes, setLockedBy, setLockedBy, setLockedByState, setNotes, setNotes, setPrimaryPropertyGroup, setPrimaryPropertyGroups, setPrimaryPropertyGroups, setPrompts, setPrompts, setProperties, setProperties, setPropertySets, setPropertySets, setReferencedObjects, setReferencedObjects, setResponsibleParties, setResponsibleParties, setSourceTransformations, setSourceTransformations, setSpecSourceTransformations, setSpecSourceTransformations, setSpecTargetTransformations, setSpecTargetTransformations, setTargetTransformations, setTargetTransformations, setTimestamps, setTimestamps, setTrees, setTrees, setTSObjectNamespace, setTSObjectNamespaces, setTSObjectNamespaces, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersionState, setUsedByPrototypes, setUsedByPrototypes, setUsingPrototype, setUsingPrototypes, setUsingPrototypes, setVariables, setVariables

Methods inherited from interface com.sas.metadata.remote.MdObjectBaseXML

closeUpdateMetadataXML, createEmptyXML, createObjectRefreshXML, createObjectXML, createObjectXML, createUpdateAssociationXML, createUpdateAssociationXML, createUpdateSimpleXML, doCreateUpdateXML, getUpdateSimpleSubstring, updateMetadataAll

Methods inherited from interface com.sas.metadata.remote.MdObjectBaseUtil

addMdObjectListener, delete, dispose, fireMdObjectModified, getAssociatedObjects, getAssociatedObjects, getAssociatedObjects, getAssociationNames, getAssocs, getAssocsWA, getAttributeNames, getAttrs, getAttrsStates, getChangeManagementState, getChgMgtExternalIdentityImportType, getClientSideOnlyObject, getMdObjectAssociation, getPopulatedAssocs, getUpdatedAttrs, getViewList, isCheckedOut, isLocked, objectModified, removeMdObjectListener, setAttrs, setChangeManagementTargetRepository, setChgMgtExternalIdentityImportType, setClientSideOnlyObject, setMdObjectAssociation, touch, updateAssnsIds

Methods inherited from interface com.sas.metadata.remote.MdObjectBase

addElementToChangeList, clearChangeList, getChangeList, getCMetadataType, getDesc, getDescMaxLength, getDescState, getFQID, getId, getIdState, getMetadataCreated, getMetadataCreatedState, getMetadataUpdated, getMetadataUpdatedState, getName, getNameMaxLength, getNameState, getObjectStore, getPredAssociations, getRepositoryID, getRequiredAssociations, getState, isAssociationRequired, isNewObject, isPredAssociation, removeElementFromChangeList, resetObject, resetState, resetStates, setCMetadataType, setDesc, setDesc, setDescState, setFQID, setFQID, setId, setId, setIdState, setMetadataCreated, setMetadataCreated, setMetadataCreatedState, setMetadataUpdated, setMetadataUpdated, setMetadataUpdatedState, setName, setName, setNameState, setObjectStore, setState

Field Detail

ATTRIBUTE_LOCATIONTYPE_NAME

static final java.lang.String ATTRIBUTE_LOCATIONTYPE_NAME

Constant used for the name of the LocationType attribute.

LocationType: The type of location, i.e. home address, office number, etc.

See Also:

Constant Field Values

ATTRIBUTE_ADDRESS_NAME

static final java.lang.String ATTRIBUTE_ADDRESS_NAME

Constant used for the name of the Address attribute.

Address: The address.

See Also:

Constant Field Values

ATTRIBUTE_CITY_NAME

static final java.lang.String ATTRIBUTE_CITY_NAME

Constant used for the name of the City attribute.

City: The city.

See Also:

Constant Field Values

ATTRIBUTE_POSTCODE_NAME

static final java.lang.String ATTRIBUTE_POSTCODE_NAME

Constant used for the name of the PostCode attribute.

PostCode: The postal code.

See Also:

Constant Field Values

ATTRIBUTE_AREA_NAME

static final java.lang.String ATTRIBUTE_AREA_NAME

Constant used for the name of the Area attribute.

Area: A region or territory.

See Also:

Constant Field Values

ATTRIBUTE_COUNTRY_NAME

static final java.lang.String ATTRIBUTE_COUNTRY_NAME

Constant used for the name of the Country attribute.

Country: The country.

See Also:

Constant Field Values

ASSOCIATION_PERSONS_NAME

static final java.lang.String ASSOCIATION_PERSONS_NAME

Constant used for the name of the Persons association.

Persons: *Unknown*

See Also:

Constant Field Values

Method Detail

initializeRequiredObjects

void initializeRequiredObjects()
                               throws java.rmi.RemoteException

(S) This initializes the Required Objects(Roles) which are:

Specified by:

initializeRequiredObjects in interface MdObjectBaseUtil

Specified by:

initializeRequiredObjects in interface Root

Specified by:

initializeRequiredObjects in interface SecondaryType

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

initializePredObjects

void initializePredObjects()
                           throws java.rmi.RemoteException

(S) Adds the Associated objects to the predObjects which are:

Specified by:

initializePredObjects in interface MdObjectBase

Specified by:

initializePredObjects in interface Root

Specified by:

initializePredObjects in interface SecondaryType

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getLocationType

java.lang.String getLocationType()
                                 throws java.rmi.RemoteException

Gets the String value of LocationType

Returns:

The LocationType

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getLocationTypeState

int getLocationTypeState()
                         throws java.rmi.RemoteException

Gets the Metadata State of LocationType

Returns:

The State.

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getLocationTypeMaxLength

int getLocationTypeMaxLength()
                             throws java.rmi.RemoteException

Gets the maximum length of LocationType

Returns:

The max size

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getAddress

java.lang.String getAddress()
                            throws java.rmi.RemoteException

Gets the String value of Address

Returns:

The Address

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getAddressState

int getAddressState()
                    throws java.rmi.RemoteException

Gets the Metadata State of Address

Returns:

The State.

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getAddressMaxLength

int getAddressMaxLength()
                        throws java.rmi.RemoteException

Gets the maximum length of Address

Returns:

The max size

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getCity

java.lang.String getCity()
                         throws java.rmi.RemoteException

Gets the String value of City

Returns:

The City

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getCityState

int getCityState()
                 throws java.rmi.RemoteException

Gets the Metadata State of City

Returns:

The State.

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getCityMaxLength

int getCityMaxLength()
                     throws java.rmi.RemoteException

Gets the maximum length of City

Returns:

The max size

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getPostCode

java.lang.String getPostCode()
                             throws java.rmi.RemoteException

Gets the String value of PostCode

Returns:

The PostCode

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getPostCodeState

int getPostCodeState()
                     throws java.rmi.RemoteException

Gets the Metadata State of PostCode

Returns:

The State.

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getPostCodeMaxLength

int getPostCodeMaxLength()
                         throws java.rmi.RemoteException

Gets the maximum length of PostCode

Returns:

The max size

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getArea

java.lang.String getArea()
                         throws java.rmi.RemoteException

Gets the String value of Area

Returns:

The Area

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getAreaState

int getAreaState()
                 throws java.rmi.RemoteException

Gets the Metadata State of Area

Returns:

The State.

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getAreaMaxLength

int getAreaMaxLength()
                     throws java.rmi.RemoteException

Gets the maximum length of Area

Returns:

The max size

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getCountry

java.lang.String getCountry()
                            throws java.rmi.RemoteException

Gets the String value of Country

Returns:

The Country

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getCountryState

int getCountryState()
                    throws java.rmi.RemoteException

Gets the Metadata State of Country

Returns:

The State.

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getCountryMaxLength

int getCountryMaxLength()
                        throws java.rmi.RemoteException

Gets the maximum length of Country

Returns:

The max size

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getPersons

AssociationList getPersons()
                           throws java.rmi.RemoteException,
                                  MdException

Gets the Association list of Persons

Returns:

The AssociationList of Persons which can be of type:
Person

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getPersons

AssociationList getPersons(boolean fGoToServer)
                           throws java.rmi.RemoteException,
                                  MdException

Gets the Associationlist of Persons

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the Persons which can be of type:
Person

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

setLocationType

void setLocationType(java.lang.String inLocationType)
                     throws java.rmi.RemoteException

Sets the LocationType value and sets the state to MetadataState.LOCAL.

Parameters:

inLocationType - String

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setLocationType

void setLocationType(java.lang.String inLocationType,
                     int state)
                     throws java.rmi.RemoteException

Sets the LocationType Metadata State.

Parameters:

inLocationType - String

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setLocationTypeState

void setLocationTypeState(int state)
                          throws java.rmi.RemoteException

Sets the Metadata State of LocationType.

Parameters:

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setAddress

void setAddress(java.lang.String inAddress)
                throws java.rmi.RemoteException

Sets the Address value and sets the state to MetadataState.LOCAL.

Parameters:

inAddress - String

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setAddress

void setAddress(java.lang.String inAddress,
                int state)
                throws java.rmi.RemoteException

Sets the Address Metadata State.

Parameters:

inAddress - String

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setAddressState

void setAddressState(int state)
                     throws java.rmi.RemoteException

Sets the Metadata State of Address.

Parameters:

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setCity

void setCity(java.lang.String inCity)
             throws java.rmi.RemoteException

Sets the City value and sets the state to MetadataState.LOCAL.

Parameters:

inCity - String

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setCity

void setCity(java.lang.String inCity,
             int state)
             throws java.rmi.RemoteException

Sets the City Metadata State.

Parameters:

inCity - String

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setCityState

void setCityState(int state)
                  throws java.rmi.RemoteException

Sets the Metadata State of City.

Parameters:

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setPostCode

void setPostCode(java.lang.String inPostCode)
                 throws java.rmi.RemoteException

Sets the PostCode value and sets the state to MetadataState.LOCAL.

Parameters:

inPostCode - String

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setPostCode

void setPostCode(java.lang.String inPostCode,
                 int state)
                 throws java.rmi.RemoteException

Sets the PostCode Metadata State.

Parameters:

inPostCode - String

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setPostCodeState

void setPostCodeState(int state)
                      throws java.rmi.RemoteException

Sets the Metadata State of PostCode.

Parameters:

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setArea

void setArea(java.lang.String inArea)
             throws java.rmi.RemoteException

Sets the Area value and sets the state to MetadataState.LOCAL.

Parameters:

inArea - String

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setArea

void setArea(java.lang.String inArea,
             int state)
             throws java.rmi.RemoteException

Sets the Area Metadata State.

Parameters:

inArea - String

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setAreaState

void setAreaState(int state)
                  throws java.rmi.RemoteException

Sets the Metadata State of Area.

Parameters:

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setCountry

void setCountry(java.lang.String inCountry)
                throws java.rmi.RemoteException

Sets the Country value and sets the state to MetadataState.LOCAL.

Parameters:

inCountry - String

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setCountry

void setCountry(java.lang.String inCountry,
                int state)
                throws java.rmi.RemoteException

Sets the Country Metadata State.

Parameters:

inCountry - String

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setCountryState

void setCountryState(int state)
                     throws java.rmi.RemoteException

Sets the Metadata State of Country.

Parameters:

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setPersons

void setPersons(AssociationList list)
                throws java.rmi.RemoteException

Sets the Persons list to be list. Objects of which can be of type:
Person

Parameters:

list - AssociationList

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setPersons

void setPersons(AssociationList inObjects,
                int state)
                throws java.rmi.RemoteException

Sets the entire Persons list to match the passed in AssociationList, sets the state of the Persons

Parameters:

inObjects - AssociationList

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.