Package com.sas.metadata.remote

Interface AttributeProperty

All Superinterfaces:
AbstractProperty, CMetadata, LocalizedType, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrototypeProperty, Remote, Root, SecondaryType
public interface AttributeProperty extends PrototypeProperty
The SAS Metadata Model provides a Prototype metadata type to define templates that can be used to create metadata entities. The AttributeProperty metadata type is used with other prototype objects to define the attributes and the values that are needed in a given scenario.

Attributes of AttributeProperty are:

Associations of AttributeProperty are:

Usage

To create an instance of this AttributeProperty, use the factory create methods.
Example: create a AttributeProperty with name "AttributeProperty_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();
 AttributeProperty myObject = (AttributeProperty) factory.createComplexMetadataObject(objectStore, "AttributeProperty_Object", MetadataObjects.ATTRIBUTEPROPERTY, "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_PROPERTYROLE_NAME

      static final String ATTRIBUTE_PROPERTYROLE_NAME
      Constant used for the name of the PropertyRole attribute.

      PropertyRole: The role of this property (load, access, initialization, etc).

      See Also:

    • ATTRIBUTE_PROPERTYNAME_NAME

      static final String ATTRIBUTE_PROPERTYNAME_NAME
      Constant used for the name of the PropertyName attribute.

      PropertyName: This attribute is the name used by the software program, for example the name of a macro variable. This object also has a 'Name' attribute that is the display name or label.

      See Also:

    • ATTRIBUTE_DEFAULTVALUE_NAME

      static final String ATTRIBUTE_DEFAULTVALUE_NAME
      Constant used for the name of the DefaultValue attribute.

      DefaultValue: The default value for this parameter.

      See Also:

    • ATTRIBUTE_SQLTYPE_NAME

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

      SQLType: SQLType

      See Also:

    • ASSOCIATION_OWNINGTYPE_NAME

      static final String ASSOCIATION_OWNINGTYPE_NAME
      Constant used for the name of the OwningType association.

      OwningType: The data type of this property.  

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getPropertyRole

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

    • getPropertyRoleState

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

    • getPropertyRoleMaxLength

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

    • getPropertyName

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

    • getPropertyNameState

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

    • getPropertyNameMaxLength

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

    • getDefaultValue

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

    • getDefaultValueState

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

    • getDefaultValueMaxLength

      int getDefaultValueMaxLength() throws RemoteException
      Gets the maximum length of DefaultValue
      Returns:
      The max size
      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.

    • getOwningTypes

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

    • getOwningType

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

    • getOwningTypes

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

    • setPropertyRole

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

    • setPropertyRole

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

    • setPropertyRoleState

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

    • setPropertyName

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

    • setPropertyName

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

    • setPropertyNameState

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

    • setDefaultValue

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

    • setDefaultValue

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

    • setDefaultValueState

      void setDefaultValueState(int state) throws RemoteException
      Sets the Metadata State of DefaultValue.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote 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.

    • setOwningTypes

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

    • setOwningTypes

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

    • setOwningType

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