Package com.sas.metadata.remote

Interface Phone

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface Phone extends SecondaryType
A phone number and the type of phone number (home, office, mobile, fax).

Attributes of Phone are:

Associations of Phone are:

Usage

To create an instance of this Phone, use the factory create methods.
Example: create a Phone with name "Phone_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();
 Phone myObject = (Phone) factory.createComplexMetadataObject(objectStore, "Phone_Object", MetadataObjects.PHONE, "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_NUMBER_NAME

      static final String ATTRIBUTE_NUMBER_NAME
      Constant used for the name of the Number attribute.

      Number: A phone number.

      See Also:

    • ATTRIBUTE_PHONETYPE_NAME

      static final String ATTRIBUTE_PHONETYPE_NAME
      Constant used for the name of the PhoneType attribute.

      PhoneType: The type of phon number: home, office, mobile, fax, etc.

      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.

    • getNumber

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

    • getNumberState

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

    • getNumberMaxLength

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

    • getPhoneType

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

    • getPhoneTypeState

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

    • getPhoneTypeMaxLength

      int getPhoneTypeMaxLength() throws RemoteException
      Gets the maximum length of PhoneType
      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.

    • setNumber

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

    • setNumber

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

    • setNumberState

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

    • setPhoneType

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

    • setPhoneType

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

    • setPhoneTypeState

      void setPhoneTypeState(int state) throws RemoteException
      Sets the Metadata State of PhoneType.
      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.