Package com.sas.metadata.remote

Interface TSNamespace

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface TSNamespace extends PrimaryType
Table server namespace.

Attributes of TSNamespace are:

Associations of TSNamespace are:

Usage

To create an instance of this TSNamespace, use the factory create methods.
Example: create a TSNamespace with name "TSNamespace_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();
 TSNamespace myObject = (TSNamespace) factory.createComplexMetadataObject(objectStore, "TSNamespace_Object", MetadataObjects.TSNAMESPACE, "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_NAMESPACETYPE_NAME

      static final String ATTRIBUTE_NAMESPACETYPE_NAME
      Constant used for the name of the NamespaceType attribute.

      NamespaceType: NamespaceType

      See Also:

    • ATTRIBUTE_FLAGS_NAME

      static final String ATTRIBUTE_FLAGS_NAME
      Constant used for the name of the Flags attribute.

      Flags: Flags

      See Also:

    • ATTRIBUTE_NAMESPACENAME_NAME

      static final String ATTRIBUTE_NAMESPACENAME_NAME
      Constant used for the name of the NamespaceName attribute.

      NamespaceName: NamespaceName

      See Also:

    • ASSOCIATION_TSACCESSKEYS_NAME

      static final String ASSOCIATION_TSACCESSKEYS_NAME
      Constant used for the name of the TSAccessKeys association.

      TSAccessKeys: The access key used by this table server namespace.  

      See Also:

    • ASSOCIATION_TSCONTAINEDNAMES_NAME

      static final String ASSOCIATION_TSCONTAINEDNAMES_NAME
      Constant used for the name of the TSContainedNames association.

      TSContainedNames: The table server names that belong to this space.  

      See Also:

    • ASSOCIATION_TSNAMESPACELOCATIONS_NAME

      static final String ASSOCIATION_TSNAMESPACELOCATIONS_NAME
      Constant used for the name of the TSNamespaceLocations association.

      TSNamespaceLocations: Location for the table server namespace.  

      See Also:

    • ASSOCIATION_TSPARENTNAMESPACE_NAME

      static final String ASSOCIATION_TSPARENTNAMESPACE_NAME
      Constant used for the name of the TSParentNamespace association.

      TSParentNamespace: The parent of this object.  

      See Also:

    • ASSOCIATION_TSOBJECTS_NAME

      static final String ASSOCIATION_TSOBJECTS_NAME
      Constant used for the name of the TSObjects association.

      TSObjects: Table server objects contained in this namespace. 

      See Also:

    • ASSOCIATION_TSSUBNAMESPACES_NAME

      static final String ASSOCIATION_TSSUBNAMESPACES_NAME
      Constant used for the name of the TSSubNamespaces association.

      TSSubNamespaces: *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 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:
      TSAccessKeys
      TSContainedNames
      TSNamespaceLocations
      TSParentNamespace
      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.

    • getNamespaceType

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

    • getNamespaceTypeState

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

    • getNamespaceTypeMaxLength

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

    • getFlags

      int getFlags() throws RemoteException
      Gets the int value of Flags
      Returns:
      The Flags
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getFlagsState

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

    • getNamespaceName

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

    • getNamespaceNameState

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

    • getNamespaceNameMaxLength

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

    • getTSAccessKeys

      AssociationList getTSAccessKeys() throws RemoteException, MdException
      Gets the AssociationList of TSAccessKeys
      Returns:
      Returns the AssociationList of TSAccessKeys which can be of type:
      SASPassword
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTSContainedNames

      AssociationList getTSContainedNames() throws RemoteException, MdException
      Gets the AssociationList of TSContainedNames
      Returns:
      Returns the AssociationList of TSContainedNames which can be of type:
      TSNameObject
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTSNamespaceLocations

      AssociationList getTSNamespaceLocations() throws RemoteException, MdException
      Gets the AssociationList of TSNamespaceLocations
      Returns:
      Returns the AssociationList of TSNamespaceLocations which can be of type:
      ContentLocation
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Directory
      AnalyticContext
      Device
      Stream
      Memory
      Connection
      SASClientConnection
      OpenClientConnection
      TCPIPConnection
      COMConnection
      Email
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTSParentNamespaces

      AssociationList getTSParentNamespaces() throws RemoteException, MdException
      Gets the AssociationList of TSParentNamespaces
      Returns:
      Returns the AssociationList of TSParentNamespaces which can be of type:
      TSNamespace
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getTSParentNamespace

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

    • getTSObjects

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

    • getTSSubNamespaces

      AssociationList getTSSubNamespaces() throws RemoteException, MdException
      Gets the Association list of TSSubNamespaces
      Returns:
      The AssociationList of TSSubNamespaces 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.

    • getTSAccessKeys

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

    • getTSContainedNames

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

    • getTSNamespaceLocations

      AssociationList getTSNamespaceLocations(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of TSNamespaceLocations
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of TSNamespaceLocations which can be of type:
      ContentLocation
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Directory
      AnalyticContext
      Device
      Stream
      Memory
      Connection
      SASClientConnection
      OpenClientConnection
      TCPIPConnection
      COMConnection
      Email
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTSParentNamespaces

      AssociationList getTSParentNamespaces(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of TSParentNamespaces
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of TSParentNamespaces 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.

    • getTSObjects

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

    • getTSSubNamespaces

      AssociationList getTSSubNamespaces(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of TSSubNamespaces
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the TSSubNamespaces 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.

    • setNamespaceType

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

    • setNamespaceType

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

    • setNamespaceTypeState

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

    • setFlags

      void setFlags(int inFlags) throws RemoteException
      Sets the Flags value and sets the state to MetadataState.LOCAL.
      Parameters:
      inFlags - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setFlags

      void setFlags(int inFlags, int state) throws RemoteException
      Sets the Flags Metadata State.
      Parameters:
      inFlags - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setFlags

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

    • setFlags

      void setFlags(String inFlags, int state) throws RemoteException
      Sets the Flags value and Metadata State.
      Parameters:
      inFlags - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setFlagsState

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

    • setNamespaceName

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

    • setNamespaceName

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

    • setNamespaceNameState

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

    • setTSAccessKeys

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

    • setTSAccessKeys

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

    • setTSContainedNames

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

    • setTSContainedNames

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

    • setTSNamespaceLocations

      void setTSNamespaceLocations(AssociationList list) throws RemoteException
      Sets the TSNamespaceLocations list to be list. Objects of which can be of type:
      ContentLocation
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Directory
      AnalyticContext
      Device
      Stream
      Memory
      Connection
      SASClientConnection
      OpenClientConnection
      TCPIPConnection
      COMConnection
      Email
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setTSNamespaceLocations

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

    • setTSParentNamespaces

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

    • setTSParentNamespaces

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

    • setTSParentNamespace

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

    • setTSObjects

      void setTSObjects(AssociationList list) throws RemoteException
      Sets the TSObjects list to be list. Objects of which can be of type:
      All types
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setTSObjects

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

    • setTSSubNamespaces

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

    • setTSSubNamespaces

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