Package com.sas.metadata.remote

Interface Tree

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface Tree extends PrimaryType
This type represents a tree that is the root node for a hierarchy of groups of metadata.

Attributes of Tree are:

Associations of Tree are:

Usage

To create an instance of this Tree, use the factory create methods.
Example: create a Tree with name "Tree_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();
 Tree myObject = (Tree) factory.createComplexMetadataObject(objectStore, "Tree_Object", MetadataObjects.TREE, "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_TREETYPE_NAME

      static final String ATTRIBUTE_TREETYPE_NAME
      Constant used for the name of the TreeType attribute.

      TreeType: This attribute allows applications to store information about what the intended use of this tree is.

      See Also:

    • ASSOCIATION_ASSOCIATEDIDENTITY_NAME

      static final String ASSOCIATION_ASSOCIATEDIDENTITY_NAME
      Constant used for the name of the AssociatedIdentity association.

      AssociatedIdentity: The identity associated with this home folder.  

      See Also:

    • ASSOCIATION_ASSOCIATEDPSPORTLET_NAME

      static final String ASSOCIATION_ASSOCIATEDPSPORTLET_NAME
      Constant used for the name of the AssociatedPSPortlet association.

      AssociatedPSPortlet: The object for which this tree contains hierarchical information.  

      See Also:

    • ASSOCIATION_MEMBERS_NAME

      static final String ASSOCIATION_MEMBERS_NAME
      Constant used for the name of the Members association.

      Members: The members of this tree.  

      See Also:

    • ASSOCIATION_PARENTTREE_NAME

      static final String ASSOCIATION_PARENTTREE_NAME
      Constant used for the name of the ParentTree association.

      ParentTree: The parent of this tree.  

      See Also:

    • ASSOCIATION_SOFTWARECOMPONENTS_NAME

      static final String ASSOCIATION_SOFTWARECOMPONENTS_NAME
      Constant used for the name of the SoftwareComponents association.

      SoftwareComponents: *Unknown* 

      See Also:

    • ASSOCIATION_SUBTREES_NAME

      static final String ASSOCIATION_SUBTREES_NAME
      Constant used for the name of the SubTrees association.

      SubTrees: *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:
      AssociatedIdentity
      AssociatedPSPortlet
      Members
      ParentTree
      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.

    • getTreeType

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

    • getTreeTypeState

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

    • getTreeTypeMaxLength

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

    • getAssociatedIdentitys

      AssociationList getAssociatedIdentitys() throws RemoteException, MdException
      Gets the AssociationList of AssociatedIdentitys
      Returns:
      Returns the AssociationList of AssociatedIdentitys which can be of type:
      Identity
      IdentityGroup
      Person
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getAssociatedIdentity

      Identity getAssociatedIdentity() throws RemoteException, MdException
      Gets the Identity for AssociatedIdentity
      Returns:
      The Identity ( null if not set) of AssociatedIdentitywhich can be of type:
      Identity
      IdentityGroup
      Person
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociatedPSPortlets

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

    • getAssociatedPSPortlet

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

    • getMembers

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

    • getParentTrees

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

    • getParentTree

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

    • getSoftwareComponents

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

    • getSubTrees

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

    • getAssociatedIdentitys

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

    • getAssociatedPSPortlets

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

    • getMembers

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

    • getParentTrees

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

    • getSoftwareComponents

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

    • getSubTrees

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

    • setTreeType

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

    • setTreeType

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

    • setTreeTypeState

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

    • setAssociatedIdentitys

      void setAssociatedIdentitys(AssociationList list) throws RemoteException
      Sets the AssociatedIdentitys list to be list. Object of which can be of type:
      Identity
      IdentityGroup
      Person
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedIdentitys

      void setAssociatedIdentitys(AssociationList list, int state) throws RemoteException
      Sets the AssociatedIdentitys list to be list. Object of which can be of type:
      Identity
      IdentityGroup
      Person
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedIdentity

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

    • setAssociatedPSPortlets

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

    • setAssociatedPSPortlets

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

    • setAssociatedPSPortlet

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

    • setMembers

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

    • setMembers

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

    • setParentTrees

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

    • setParentTrees

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

    • setParentTree

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

    • setSoftwareComponents

      void setSoftwareComponents(AssociationList list) throws RemoteException
      Sets the SoftwareComponents 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.

    • setSoftwareComponents

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

    • setSubTrees

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

    • setSubTrees

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