Package com.sas.metadata.remote

Interface Location

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, 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:

Associations of Location are:

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 Details

    • ATTRIBUTE_LOCATIONTYPE_NAME

      static final 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:

    • ATTRIBUTE_ADDRESS_NAME

      static final String ATTRIBUTE_ADDRESS_NAME
      Constant used for the name of the Address attribute.

      Address: The address.

      See Also:

    • ATTRIBUTE_CITY_NAME

      static final String ATTRIBUTE_CITY_NAME
      Constant used for the name of the City attribute.

      City: The city.

      See Also:

    • ATTRIBUTE_POSTCODE_NAME

      static final String ATTRIBUTE_POSTCODE_NAME
      Constant used for the name of the PostCode attribute.

      PostCode: The postal code.

      See Also:

    • ATTRIBUTE_AREA_NAME

      static final String ATTRIBUTE_AREA_NAME
      Constant used for the name of the Area attribute.

      Area: A region or territory.

      See Also:

    • ATTRIBUTE_COUNTRY_NAME

      static final String ATTRIBUTE_COUNTRY_NAME
      Constant used for the name of the Country attribute.

      Country: The country.

      See Also:

    • ASSOCIATION_PERSONS_NAME

      static final String ASSOCIATION_PERSONS_NAME
      Constant used for the name of the Persons association.

      Persons: *Unknown* 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws 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:
      RemoteException - If error connecting/communicating to/with remote object.

    • initializePredObjects

      void initializePredObjects() throws 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:
      RemoteException - If error connecting/communicating to/with remote object.

    • getLocationType

      String getLocationType() throws RemoteException
      Gets the String value of LocationType
      Returns:
      The LocationType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getLocationTypeState

      int getLocationTypeState() throws RemoteException
      Gets the Metadata State of LocationType
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getLocationTypeMaxLength

      int getLocationTypeMaxLength() throws RemoteException
      Gets the maximum length of LocationType
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getAddress

      String getAddress() throws RemoteException
      Gets the String value of Address
      Returns:
      The Address
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getAddressState

      int getAddressState() throws RemoteException
      Gets the Metadata State of Address
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getAddressMaxLength

      int getAddressMaxLength() throws RemoteException
      Gets the maximum length of Address
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getCity

      String getCity() throws RemoteException
      Gets the String value of City
      Returns:
      The City
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getCityState

      int getCityState() throws RemoteException
      Gets the Metadata State of City
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getCityMaxLength

      int getCityMaxLength() throws RemoteException
      Gets the maximum length of City
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getPostCode

      String getPostCode() throws RemoteException
      Gets the String value of PostCode
      Returns:
      The PostCode
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getPostCodeState

      int getPostCodeState() throws RemoteException
      Gets the Metadata State of PostCode
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getPostCodeMaxLength

      int getPostCodeMaxLength() throws RemoteException
      Gets the maximum length of PostCode
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getArea

      String getArea() throws RemoteException
      Gets the String value of Area
      Returns:
      The Area
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getAreaState

      int getAreaState() throws RemoteException
      Gets the Metadata State of Area
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getAreaMaxLength

      int getAreaMaxLength() throws RemoteException
      Gets the maximum length of Area
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getCountry

      String getCountry() throws RemoteException
      Gets the String value of Country
      Returns:
      The Country
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getCountryState

      int getCountryState() throws RemoteException
      Gets the Metadata State of Country
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getCountryMaxLength

      int getCountryMaxLength() throws RemoteException
      Gets the maximum length of Country
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getPersons

      AssociationList getPersons() throws RemoteException, MdException
      Gets the Association list of Persons
      Returns:
      The AssociationList of Persons which can be of type:
      Person
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getPersons

      AssociationList getPersons(boolean fGoToServer) throws 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:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setLocationType

      void setLocationType(String inLocationType) throws RemoteException
      Sets the LocationType value and sets the state to MetadataState.LOCAL.
      Parameters:
      inLocationType - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setLocationType

      void setLocationType(String inLocationType, int state) throws RemoteException
      Sets the LocationType Metadata State.
      Parameters:
      inLocationType - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setLocationTypeState

      void setLocationTypeState(int state) throws RemoteException
      Sets the Metadata State of LocationType.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAddress

      void setAddress(String inAddress) throws RemoteException
      Sets the Address value and sets the state to MetadataState.LOCAL.
      Parameters:
      inAddress - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setAddress

      void setAddress(String inAddress, int state) throws RemoteException
      Sets the Address Metadata State.
      Parameters:
      inAddress - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAddressState

      void setAddressState(int state) throws RemoteException
      Sets the Metadata State of Address.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setCity

      void setCity(String inCity) throws RemoteException
      Sets the City value and sets the state to MetadataState.LOCAL.
      Parameters:
      inCity - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setCity

      void setCity(String inCity, int state) throws RemoteException
      Sets the City Metadata State.
      Parameters:
      inCity - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setCityState

      void setCityState(int state) throws RemoteException
      Sets the Metadata State of City.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setPostCode

      void setPostCode(String inPostCode) throws RemoteException
      Sets the PostCode value and sets the state to MetadataState.LOCAL.
      Parameters:
      inPostCode - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setPostCode

      void setPostCode(String inPostCode, int state) throws RemoteException
      Sets the PostCode Metadata State.
      Parameters:
      inPostCode - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setPostCodeState

      void setPostCodeState(int state) throws RemoteException
      Sets the Metadata State of PostCode.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setArea

      void setArea(String inArea) throws RemoteException
      Sets the Area value and sets the state to MetadataState.LOCAL.
      Parameters:
      inArea - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setArea

      void setArea(String inArea, int state) throws RemoteException
      Sets the Area Metadata State.
      Parameters:
      inArea - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAreaState

      void setAreaState(int state) throws RemoteException
      Sets the Metadata State of Area.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setCountry

      void setCountry(String inCountry) throws RemoteException
      Sets the Country value and sets the state to MetadataState.LOCAL.
      Parameters:
      inCountry - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setCountry

      void setCountry(String inCountry, int state) throws RemoteException
      Sets the Country Metadata State.
      Parameters:
      inCountry - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setCountryState

      void setCountryState(int state) throws RemoteException
      Sets the Metadata State of Country.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setPersons

      void setPersons(AssociationList list) throws RemoteException
      Sets the Persons list to be list. Objects of which can be of type:
      Person
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setPersons

      void setPersons(AssociationList inObjects, int state) throws RemoteException
      Sets the entire Persons list to match the passed in AssociationList, sets the state of the Persons
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.