Package com.sas.metadata.remote

Interface PropertyGroup

All Superinterfaces:
CMetadata, LocalizedType, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface PropertyGroup extends LocalizedType
Represents a group of properties. The properties that are part of this group are associated using the GroupedProperties association.

Attributes of PropertyGroup are:

Associations of PropertyGroup are:

Usage

To create an instance of this PropertyGroup, use the factory create methods.
Example: create a PropertyGroup with name "PropertyGroup_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();
 PropertyGroup myObject = (PropertyGroup) factory.createComplexMetadataObject(objectStore, "PropertyGroup_Object", MetadataObjects.PROPERTYGROUP, "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_ISVISIBLE_NAME

      static final String ATTRIBUTE_ISVISIBLE_NAME
      Constant used for the name of the IsVisible attribute.

      IsVisible: Should this property be displayed in a UI?

      See Also:

    • ATTRIBUTE_MINIMUM_NAME

      static final String ATTRIBUTE_MINIMUM_NAME
      Constant used for the name of the Minimum attribute.

      Minimum: This is an optional attribute that describes the minimum number of property objects in this group that must have values.

      See Also:

    • ATTRIBUTE_MAXIMUM_NAME

      static final String ATTRIBUTE_MAXIMUM_NAME
      Constant used for the name of the Maximum attribute.

      Maximum: This is an optional attribute that describes the maximum number of property objects in this group that may have settings.

      See Also:

    • ASSOCIATION_ASSOCIATEDOBJECT_NAME

      static final String ASSOCIATION_ASSOCIATEDOBJECT_NAME
      Constant used for the name of the AssociatedObject association.

      AssociatedObject: The object that uses this group of properties.  

      See Also:

    • ASSOCIATION_CUSTOMIZERS_NAME

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

      Customizers: The programs that customizes this property group.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_PARENTGROUP_NAME

      static final String ASSOCIATION_PARENTGROUP_NAME
      Constant used for the name of the ParentGroup association.

      ParentGroup: The parent group for this group of properties.  

      See Also:

    • ASSOCIATION_GROUPEDPROPERTIES_NAME

      static final String ASSOCIATION_GROUPEDPROPERTIES_NAME
      Constant used for the name of the GroupedProperties association.

      GroupedProperties: The properties in this group. 

      See Also:

    • ASSOCIATION_SUBPROPERTYGROUPS_NAME

      static final String ASSOCIATION_SUBPROPERTYGROUPS_NAME
      Constant used for the name of the SubpropertyGroups association.

      SubpropertyGroups: The subgroups for this group of properties. 

      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:
      AssociatedObject
      Customizers
      ParentGroup
      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.

    • getIsVisible

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

    • getIsVisibleState

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

    • getMinimum

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

    • getMinimumState

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

    • getMaximum

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

    • getMaximumState

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

    • getAssociatedObjects

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

    • getAssociatedObject

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

    • getCustomizers

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

    • getParentGroups

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

    • getParentGroup

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

    • getGroupedProperties

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

    • getSubpropertyGroups

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

    • getAssociatedObjects

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

    • 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 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.

    • getParentGroups

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

    • getGroupedProperties

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

    • getSubpropertyGroups

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

    • setIsVisible

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

    • setIsVisible

      void setIsVisible(int inIsVisible, int state) throws RemoteException
      Sets the IsVisible Metadata State.
      Parameters:
      inIsVisible - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsVisible

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

    • setIsVisible

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

    • setIsVisibleState

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

    • setMinimum

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

    • setMinimum

      void setMinimum(int inMinimum, int state) throws RemoteException
      Sets the Minimum Metadata State.
      Parameters:
      inMinimum - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setMinimum

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

    • setMinimum

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

    • setMinimumState

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

    • setMaximum

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

    • setMaximum

      void setMaximum(int inMaximum, int state) throws RemoteException
      Sets the Maximum Metadata State.
      Parameters:
      inMaximum - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setMaximum

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

    • setMaximum

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

    • setMaximumState

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

    • setAssociatedObjects

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

    • setAssociatedObjects

      void setAssociatedObjects(AssociationList list, int state) throws RemoteException
      Sets the AssociatedObjects 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.

    • setAssociatedObject

      void setAssociatedObject(Root inObject) throws RemoteException
      Sets the AssociatedObjects list 0th element to be inObject.
      Parameters:
      inObject - Root
      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 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.

    • setParentGroups

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

    • setParentGroups

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

    • setParentGroup

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

    • setGroupedProperties

      void setGroupedProperties(AssociationList list) throws RemoteException
      Sets the GroupedProperties list to be list. Objects of which can be of type:
      AbstractProperty
      Property
      PrototypeProperty
      AttributeProperty
      AssociationProperty
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setGroupedProperties

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

    • setSubpropertyGroups

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

    • setSubpropertyGroups

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