Package com.sas.metadata.remote

Interface TSNameObject

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface TSNameObject extends PrimaryType
Table server name object.

Attributes of TSNameObject are:

Associations of TSNameObject are:

Usage

To create an instance of this TSNameObject, use the factory create methods.
Example: create a TSNameObject with name "TSNameObject_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();
 TSNameObject myObject = (TSNameObject) factory.createComplexMetadataObject(objectStore, "TSNameObject_Object", MetadataObjects.TSNAMEOBJECT, "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_NAMEOBJECTNAME_NAME

      static final String ATTRIBUTE_NAMEOBJECTNAME_NAME
      Constant used for the name of the NameObjectName attribute.

      NameObjectName: NameObjectName

      See Also:

    • ASSOCIATION_TSCONTAININGNAMESPACE_NAME

      static final String ASSOCIATION_TSCONTAININGNAMESPACE_NAME
      Constant used for the name of the TSContainingNamespace association.

      TSContainingNamespace: The table server namespace for this name object. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      TSContainingNamespace
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface PrimaryType
      Specified by:
      initializeRequiredObjects in interface Root
      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 PrimaryType
      Specified by:
      initializePredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getNameObjectName

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

    • getNameObjectNameState

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

    • getNameObjectNameMaxLength

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

    • getTSContainingNamespaces

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

    • getTSContainingNamespace

      TSNamespace getTSContainingNamespace() throws RemoteException, MdException
      Gets the TSNamespace for TSContainingNamespace
      Returns:
      The TSNamespace ( null if not set ) of TSContainingNamespace which can be of type:
      TSNamespace
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTSContainingNamespaces

      AssociationList getTSContainingNamespaces(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of TSContainingNamespaces
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the TSContainingNamespaces which can be of type:
      TSNamespace
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setNameObjectName

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

    • setNameObjectName

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

    • setNameObjectNameState

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

    • setTSContainingNamespaces

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

    • setTSContainingNamespaces

      void setTSContainingNamespaces(AssociationList list, int state) throws RemoteException
      Sets the TSContainingNamespaces list to be list. Objects of which can be of type:
      TSNamespace
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setTSContainingNamespace

      void setTSContainingNamespace(TSNamespace inObject) throws RemoteException
      Sets the TSContainingNamespaces list 0th element to be inObject.
      Parameters:
      inObject - TSNamespace
      Throws:
      RemoteException - If error communicating with remote object.