Package com.sas.metadata.remote

Interface PropertySet

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface PropertySet extends SecondaryType
A PropertySet contains a complete set of properties to be used by the OwningObject in a particular context. The properties that are part of this set are associated using the SetProperties association. Additional information regarding the charateristics or context of the PropertySet is modeled using the Properties association. Note that Properties extend the PropertySet and SetProperties are the set of Properties that extend the OwningObject.

Attributes of PropertySet are:

Associations of PropertySet are:

Usage

To create an instance of this PropertySet, use the factory create methods.
Example: create a PropertySet with name "PropertySet_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();
 PropertySet myObject = (PropertySet) factory.createComplexMetadataObject(objectStore, "PropertySet_Object", MetadataObjects.PROPERTYSET, "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_SETROLE_NAME

      static final String ATTRIBUTE_SETROLE_NAME
      Constant used for the name of the SetRole attribute.

      SetRole: The role identifies the usage of this property set. For example, there may be multiple PropertySet objects for dataset options, for Read, Update, Create. The Role attribute helps identify the usage of the PropertySet.

      See Also:

    • ATTRIBUTE_PROPERTYSETNAME_NAME

      static final String ATTRIBUTE_PROPERTYSETNAME_NAME
      Constant used for the name of the PropertySetName attribute.

      PropertySetName: The name of the property set as used by an application. This name is not localized.

      See Also:

    • ASSOCIATION_OWNINGOBJECT_NAME

      static final String ASSOCIATION_OWNINGOBJECT_NAME
      Constant used for the name of the OwningObject association.

      OwningObject: The object that owns the Property objects in the PropertySet.  

      See Also:

    • ASSOCIATION_SETPROPERTIES_NAME

      static final String ASSOCIATION_SETPROPERTIES_NAME
      Constant used for the name of the SetProperties association.

      SetProperties: The property objects contained in this set.  

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      OwningObject
      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:
      OwningObject
      SetProperties
      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.

    • getSetRole

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

    • getSetRoleState

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

    • getSetRoleMaxLength

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

    • getPropertySetName

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

    • getPropertySetNameState

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

    • getPropertySetNameMaxLength

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

    • getOwningObjects

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

    • getOwningObject

      Root getOwningObject() throws RemoteException, MdException
      Gets the Root for OwningObject
      Returns:
      The Root ( null if not set) of OwningObjectwhich 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.

    • getSetProperties

      AssociationList getSetProperties() throws RemoteException, MdException
      Gets the AssociationList of SetProperties
      Returns:
      Returns the AssociationList of SetProperties 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.

    • getOwningObjects

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

    • getSetProperties

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

    • setSetRole

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

    • setSetRole

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

    • setSetRoleState

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

    • setPropertySetName

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

    • setPropertySetName

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

    • setPropertySetNameState

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

    • setOwningObjects

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

    • setOwningObjects

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

    • setOwningObject

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

    • setSetProperties

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

    • setSetProperties

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