Package com.sas.metadata.remote

Interface PropertyType

All Superinterfaces:
CMetadata, LocalizedType, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface PropertyType extends LocalizedType
Defines the data type of a property. Beginning with SAS 9.2, PropertyType is no longer a shared resource; instead, it is contained by the Property object that it helps to define. PropertyType is no longer considered to be an owning type. The SQL type of a Property object is now recorded in the SQLType= attribute of the Property object. Use PropertyType when the SQL type is set to other, 1111, or array, 2003 and more detail is needed to describe the type.

Attributes of PropertyType are:

Associations of PropertyType are:

Usage

To create an instance of this PropertyType, use the factory create methods.
Example: create a PropertyType with name "PropertyType_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();
 PropertyType myObject = (PropertyType) factory.createComplexMetadataObject(objectStore, "PropertyType_Object", MetadataObjects.PROPERTYTYPE, "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_SQLTYPE_NAME

      static final String ATTRIBUTE_SQLTYPE_NAME
      Constant used for the name of the SQLType attribute.

      SQLType: This is an integer value that identifies the SQL type of the data.

    • ARRAY = 2003
    • BIGINT = -5
    • BINARY = -2
    • BIT = -7
    • BLOB = 2004
    • CHAR = 1
    • CLOB = 2005
    • DATE = 91
    • DECIMAL = 3
    • DISTINCT = 2001
    • DOUBLE = 8
    • FLOAT = 6
    • INTEGER = 4
    • JAVA_OBJECT = 2000
    • LONGVARBINARY = -4
    • LONGVARCHAR = -1
    • NULL = 0
    • NUMERIC = 2
    • OTHER = 1111
    • REAL = 7
    • REF = 2006
    • SMALLINT = 5
    • STRUCT = 2002
    • TIME = 92
    • TIMESTAMP = 93
    • TINYINT = -6
    • VARBINARY = -3
    • VARCHAR = 12
    • QuotedString = 2200
      • See Also:

    • ASSOCIATION_ARRAYTYPES_NAME

      static final String ASSOCIATION_ARRAYTYPES_NAME
      Constant used for the name of the ArrayTypes association.

      ArrayTypes: The arrays that use this PropertyType.  

      See Also:

    • ASSOCIATION_CUSTOMIZERS_NAME

      static final String ASSOCIATION_CUSTOMIZERS_NAME
      Constant used for the name of the Customizers association.

      Customizers: The programs used to customize this object. A customizer is a standalone editor used to customize or edit a value. It does not reside inside a UI element as an editor does, but defines it's own window. If none exists on the entity, the customizer of the property type is returned. 

      See Also:

    • ASSOCIATION_EDITORS_NAME

      static final String ASSOCIATION_EDITORS_NAME
      Constant used for the name of the Editors association.

      Editors: The programs that can edit this object. The editor is a component that can be placed inside a UI container, such as a property sheet, and that edits the property value. 

      See Also:

    • ASSOCIATION_ELEMENTTYPE_NAME

      static final String ASSOCIATION_ELEMENTTYPE_NAME
      Constant used for the name of the ElementType association.

      ElementType: The PropertyType used in this array. 

      See Also:

    • ASSOCIATION_STOREDCONFIGURATION_NAME

      static final String ASSOCIATION_STOREDCONFIGURATION_NAME
      Constant used for the name of the StoredConfiguration association.

      StoredConfiguration: The configuration information for this object. 

      See Also:

    • ASSOCIATION_TYPEDATTPROPERTIES_NAME

      static final String ASSOCIATION_TYPEDATTPROPERTIES_NAME
      Constant used for the name of the TypedAttProperties association.

      TypedAttProperties: The attribute properties that are of this type. 

      See Also:

    • ASSOCIATION_TYPEDPROPERTIES_NAME

      static final String ASSOCIATION_TYPEDPROPERTIES_NAME
      Constant used for the name of the TypedProperties association.

      TypedProperties: The properties that are of this type. 

      See Also:

    • ASSOCIATION_VALIDATORS_NAME

      static final String ASSOCIATION_VALIDATORS_NAME
      Constant used for the name of the Validators association.

      Validators: The programs used to validate the value of this PropertyType. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface LocalizedType
      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:
      ArrayTypes
      Specified by:
      initializePredObjects in interface LocalizedType
      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.

    • getSQLType

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

    • getSQLTypeState

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

    • getArrayTypes

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

    • getCustomizers

      AssociationList getCustomizers() throws RemoteException, MdException
      Gets the Association list of Customizers
      Returns:
      The AssociationList of Customizers which can be of type:
      SoftwareComponent
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getEditors

      AssociationList getEditors() throws RemoteException, MdException
      Gets the Association list of Editors
      Returns:
      The AssociationList of Editors which can be of type:
      SoftwareComponent
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getElementTypes

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

    • getElementType

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

    • getStoredConfigurations

      AssociationList getStoredConfigurations() throws RemoteException, MdException
      Gets the Association list of StoredConfigurations
      Returns:
      The AssociationList of StoredConfigurations which can be of type:
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getStoredConfiguration

      Text getStoredConfiguration() throws RemoteException, MdException
      Gets the Text for StoredConfiguration
      Returns:
      The Text ( null if not set ) of StoredConfiguration which can be of type:
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTypedAttProperties

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

    • getTypedProperties

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

    • getValidators

      AssociationList getValidators() throws RemoteException, MdException
      Gets the Association list of Validators
      Returns:
      The AssociationList of Validators which can be of type:
      SoftwareComponent
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getArrayTypes

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

    • getCustomizers

      AssociationList getCustomizers(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of Customizers
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the Customizers which can be of type:
      SoftwareComponent
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getEditors

      AssociationList getEditors(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of Editors
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the Editors which can be of type:
      SoftwareComponent
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getElementTypes

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

    • getStoredConfigurations

      AssociationList getStoredConfigurations(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of StoredConfigurations
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the StoredConfigurations which can be of type:
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTypedAttProperties

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

    • getTypedProperties

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

    • getValidators

      AssociationList getValidators(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of Validators
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the Validators which can be of type:
      SoftwareComponent
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setSQLType

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

    • setSQLType

      void setSQLType(int inSQLType, int state) throws RemoteException
      Sets the SQLType Metadata State.
      Parameters:
      inSQLType - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setSQLType

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

    • setSQLType

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

    • setSQLTypeState

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

    • setArrayTypes

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

    • setArrayTypes

      void setArrayTypes(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.

    • setCustomizers

      void setCustomizers(AssociationList list) throws RemoteException
      Sets the Customizers list to be list. Objects of which can be of type:
      SoftwareComponent
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setCustomizers

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

    • setEditors

      void setEditors(AssociationList list) throws RemoteException
      Sets the Editors list to be list. Objects of which can be of type:
      SoftwareComponent
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setEditors

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

    • setElementTypes

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

    • setElementTypes

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

    • setElementType

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

    • setStoredConfigurations

      void setStoredConfigurations(AssociationList list) throws RemoteException
      Sets the StoredConfigurations list to be list. Objects of which can be of type:
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setStoredConfigurations

      void setStoredConfigurations(AssociationList list, int state) throws RemoteException
      Sets the StoredConfigurations list to be list. Objects of which can be of type:
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setStoredConfiguration

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

    • setTypedAttProperties

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

    • setTypedAttProperties

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

    • setTypedProperties

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

    • setTypedProperties

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

    • setValidators

      void setValidators(AssociationList list) throws RemoteException
      Sets the Validators list to be list. Objects of which can be of type:
      SoftwareComponent
      DeployedComponent
      ConfiguredComponent
      ServiceComponent
      ServerComponent
      LogicalServer
      ServerContext
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setValidators

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